3 * Preparation for the final page rendering.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use MediaWiki\Linker\LinkTarget
;
24 use MediaWiki\MediaWikiServices
;
25 use MediaWiki\Session\SessionManager
;
26 use Wikimedia\Rdbms\IResultWrapper
;
27 use Wikimedia\RelPath
;
28 use Wikimedia\WrappedString
;
29 use Wikimedia\WrappedStringList
;
32 * This class should be covered by a general architecture document which does
33 * not exist as of January 2011. This is one of the Core classes and should
34 * be read at least once by any new developers.
36 * This class is used to prepare the final rendering. A skin is then
37 * applied to the output parameters (links, javascript, html, categories ...).
39 * @todo FIXME: Another class handles sending the whole page to the client.
41 * Some comments comes from a pairing session between Zak Greant and Antoine Musso
46 class OutputPage
extends ContextSource
{
47 /** @var array Should be private. Used with addMeta() which adds "<meta>" */
48 protected $mMetatags = [];
51 protected $mLinktags = [];
54 protected $mCanonicalUrl = false;
57 * @var string The contents of <h1> */
58 private $mPageTitle = '';
61 * @var string The displayed title of the page. Different from page title
62 * if overridden by display title magic word or hooks. Can contain safe
63 * HTML. Different from page title which may contain messages such as
64 * "Editing X" which is displayed in h1. This can be used for other places
65 * where the page name is referred on the page.
67 private $displayTitle;
70 * @var string Contains all of the "<body>" content. Should be private we
71 * got set/get accessors and the append() method.
73 public $mBodytext = '';
75 /** @var string Stores contents of "<title>" tag */
76 private $mHTMLtitle = '';
79 * @var bool Is the displayed content related to the source of the
80 * corresponding wiki article.
82 private $mIsArticle = false;
84 /** @var bool Stores "article flag" toggle. */
85 private $mIsArticleRelated = true;
87 /** @var bool Is the content subject to copyright */
88 private $mHasCopyright = false;
91 * @var bool We have to set isPrintable(). Some pages should
92 * never be printed (ex: redirections).
94 private $mPrintable = false;
97 * @var array Contains the page subtitle. Special pages usually have some
98 * links here. Don't confuse with site subtitle added by skins.
100 private $mSubtitle = [];
103 public $mRedirect = '';
106 protected $mStatusCode;
109 * @var string Used for sending cache control.
110 * The whole caching system should probably be moved into its own class.
112 protected $mLastModified = '';
115 protected $mCategoryLinks = [];
118 protected $mCategories = [
124 protected $mIndicators = [];
126 /** @var array Array of Interwiki Prefixed (non DB key) Titles (e.g. 'fr:Test page') */
127 private $mLanguageLinks = [];
130 * Used for JavaScript (predates ResourceLoader)
131 * @todo We should split JS / CSS.
132 * mScripts content is inserted as is in "<head>" by Skin. This might
133 * contain either a link to a stylesheet or inline CSS.
135 private $mScripts = '';
137 /** @var string Inline CSS styles. Use addInlineStyle() sparingly */
138 protected $mInlineStyles = '';
141 * @var string Used by skin template.
142 * Example: $tpl->set( 'displaytitle', $out->mPageLinkTitle );
144 public $mPageLinkTitle = '';
146 /** @var array Array of elements in "<head>". Parser might add its own headers! */
147 protected $mHeadItems = [];
149 /** @var array Additional <body> classes; there are also <body> classes from other sources */
150 protected $mAdditionalBodyClasses = [];
153 protected $mModules = [];
156 protected $mModuleStyles = [];
158 /** @var ResourceLoader */
159 protected $mResourceLoader;
161 /** @var ResourceLoaderClientHtml */
164 /** @var ResourceLoaderContext */
165 private $rlClientContext;
168 private $rlExemptStyleModules;
171 protected $mJsConfigVars = [];
174 protected $mTemplateIds = [];
177 protected $mImageTimeKeys = [];
180 public $mRedirectCode = '';
182 protected $mFeedLinksAppendQuery = null;
185 * What level of 'untrustworthiness' is allowed in CSS/JS modules loaded on this page?
186 * @see ResourceLoaderModule::$origin
187 * ResourceLoaderModule::ORIGIN_ALL is assumed unless overridden;
189 protected $mAllowedModules = [
190 ResourceLoaderModule
::TYPE_COMBINED
=> ResourceLoaderModule
::ORIGIN_ALL
,
193 /** @var bool Whether output is disabled. If this is true, the 'output' method will do nothing. */
194 protected $mDoNothing = false;
199 protected $mContainsNewMagic = 0;
202 * lazy initialised, use parserOptions()
205 protected $mParserOptions = null;
208 * Handles the Atom / RSS links.
209 * We probably only support Atom in 2011.
210 * @see $wgAdvertisedFeedTypes
212 private $mFeedLinks = [];
214 // Gwicke work on squid caching? Roughly from 2003.
215 protected $mEnableClientCache = true;
217 /** @var bool Flag if output should only contain the body of the article. */
218 private $mArticleBodyOnly = false;
221 protected $mNewSectionLink = false;
224 protected $mHideNewSectionLink = false;
227 * @var bool Comes from the parser. This was probably made to load CSS/JS
228 * only if we had "<gallery>". Used directly in CategoryPage.php.
229 * Looks like ResourceLoader can replace this.
231 public $mNoGallery = false;
233 /** @var int Cache stuff. Looks like mEnableClientCache */
234 protected $mCdnMaxage = 0;
235 /** @var int Upper limit on mCdnMaxage */
236 protected $mCdnMaxageLimit = INF
;
239 * @var bool Controls if anti-clickjacking / frame-breaking headers will
240 * be sent. This should be done for pages where edit actions are possible.
241 * Setters: $this->preventClickjacking() and $this->allowClickjacking().
243 protected $mPreventClickjacking = true;
245 /** @var int To include the variable {{REVISIONID}} */
246 private $mRevisionId = null;
249 private $mRevisionTimestamp = null;
252 protected $mFileVersion = null;
255 * @var array An array of stylesheet filenames (relative from skins path),
256 * with options for CSS media, IE conditions, and RTL/LTR direction.
257 * For internal use; add settings in the skin via $this->addStyle()
259 * Style again! This seems like a code duplication since we already have
260 * mStyles. This is what makes Open Source amazing.
262 protected $styles = [];
264 private $mIndexPolicy = 'index';
265 private $mFollowPolicy = 'follow';
268 * @var array Headers that cause the cache to vary. Key is header name, value is an array of
269 * options for the Key header.
271 private $mVaryHeader = [
272 'Accept-Encoding' => [ 'match=gzip' ],
276 * If the current page was reached through a redirect, $mRedirectedFrom contains the Title
281 private $mRedirectedFrom = null;
284 * Additional key => value data
286 private $mProperties = [];
289 * @var string|null ResourceLoader target for load.php links. If null, will be omitted
291 private $mTarget = null;
294 * @var bool Whether parser output contains a table of contents
296 private $mEnableTOC = false;
299 * @var string|null The URL to send in a <link> element with rel=license
301 private $copyrightUrl;
303 /** @var array Profiling data */
304 private $limitReportJSData = [];
306 /** @var array Map Title to Content */
307 private $contentOverrides = [];
309 /** @var callable[] */
310 private $contentOverrideCallbacks = [];
313 * Link: header contents
315 private $mLinkHeader = [];
318 * @var string The nonce for Content-Security-Policy
323 * @var array A cache of the names of the cookies that will influence the cache
325 private static $cacheVaryCookies = null;
328 * Constructor for OutputPage. This should not be called directly.
329 * Instead a new RequestContext should be created and it will implicitly create
330 * a OutputPage tied to that context.
331 * @param IContextSource $context
333 function __construct( IContextSource
$context ) {
334 $this->setContext( $context );
338 * Redirect to $url rather than displaying the normal page
341 * @param string $responsecode HTTP status code
343 public function redirect( $url, $responsecode = '302' ) {
344 # Strip newlines as a paranoia check for header injection in PHP<5.1.2
345 $this->mRedirect
= str_replace( "\n", '', $url );
346 $this->mRedirectCode
= $responsecode;
350 * Get the URL to redirect to, or an empty string if not redirect URL set
354 public function getRedirect() {
355 return $this->mRedirect
;
359 * Set the copyright URL to send with the output.
360 * Empty string to omit, null to reset.
364 * @param string|null $url
366 public function setCopyrightUrl( $url ) {
367 $this->copyrightUrl
= $url;
371 * Set the HTTP status code to send with the output.
373 * @param int $statusCode
375 public function setStatusCode( $statusCode ) {
376 $this->mStatusCode
= $statusCode;
380 * Add a new "<meta>" tag
381 * To add an http-equiv meta tag, precede the name with "http:"
383 * @param string $name Name of the meta tag
384 * @param string $val Value of the meta tag
386 function addMeta( $name, $val ) {
387 array_push( $this->mMetatags
, [ $name, $val ] );
391 * Returns the current <meta> tags
396 public function getMetaTags() {
397 return $this->mMetatags
;
401 * Add a new \<link\> tag to the page header.
403 * Note: use setCanonicalUrl() for rel=canonical.
405 * @param array $linkarr Associative array of attributes.
407 function addLink( array $linkarr ) {
408 array_push( $this->mLinktags
, $linkarr );
412 * Returns the current <link> tags
417 public function getLinkTags() {
418 return $this->mLinktags
;
422 * Set the URL to be used for the <link rel=canonical>. This should be used
423 * in preference to addLink(), to avoid duplicate link tags.
426 function setCanonicalUrl( $url ) {
427 $this->mCanonicalUrl
= $url;
431 * Returns the URL to be used for the <link rel=canonical> if
435 * @return bool|string
437 public function getCanonicalUrl() {
438 return $this->mCanonicalUrl
;
442 * Add raw HTML to the list of scripts (including \<script\> tag, etc.)
443 * Internal use only. Use OutputPage::addModules() or OutputPage::addJsConfigVars()
446 * @param string $script Raw HTML
448 function addScript( $script ) {
449 $this->mScripts
.= $script;
453 * Add a JavaScript file to be loaded as `<script>` on this page.
455 * Internal use only. Use OutputPage::addModules() if possible.
457 * @param string $file URL to file (absolute path, protocol-relative, or full url)
458 * @param string|null $unused Previously used to change the cache-busting query parameter
460 public function addScriptFile( $file, $unused = null ) {
461 if ( substr( $file, 0, 1 ) !== '/' && !preg_match( '#^[a-z]*://#i', $file ) ) {
462 // This is not an absolute path, protocol-relative url, or full scheme url,
463 // presumed to be an old call intended to include a file from /w/skins/common,
464 // which doesn't exist anymore as of MediaWiki 1.24 per T71277. Ignore.
465 wfDeprecated( __METHOD__
, '1.24' );
468 $this->addScript( Html
::linkedScript( $file, $this->getCSPNonce() ) );
472 * Add a self-contained script tag with the given contents
473 * Internal use only. Use OutputPage::addModules() if possible.
475 * @param string $script JavaScript text, no script tags
477 public function addInlineScript( $script ) {
478 $this->mScripts
.= Html
::inlineScript( "\n$script\n", $this->getCSPNonce() ) . "\n";
482 * Filter an array of modules to remove insufficiently trustworthy members, and modules
483 * which are no longer registered (eg a page is cached before an extension is disabled)
484 * @param array $modules
485 * @param string|null $position Unused
486 * @param string $type
489 protected function filterModules( array $modules, $position = null,
490 $type = ResourceLoaderModule
::TYPE_COMBINED
492 $resourceLoader = $this->getResourceLoader();
493 $filteredModules = [];
494 foreach ( $modules as $val ) {
495 $module = $resourceLoader->getModule( $val );
496 if ( $module instanceof ResourceLoaderModule
497 && $module->getOrigin() <= $this->getAllowedModules( $type )
499 if ( $this->mTarget
&& !in_array( $this->mTarget
, $module->getTargets() ) ) {
500 $this->warnModuleTargetFilter( $module->getName() );
503 $filteredModules[] = $val;
506 return $filteredModules;
509 private function warnModuleTargetFilter( $moduleName ) {
510 static $warnings = [];
511 if ( isset( $warnings[$this->mTarget
][$moduleName] ) ) {
514 $warnings[$this->mTarget
][$moduleName] = true;
515 $this->getResourceLoader()->getLogger()->debug(
516 'Module "{module}" not loadable on target "{target}".',
518 'module' => $moduleName,
519 'target' => $this->mTarget
,
525 * Get the list of modules to include on this page
527 * @param bool $filter Whether to filter out insufficiently trustworthy modules
528 * @param string|null $position Unused
529 * @param string $param
530 * @param string $type
531 * @return array Array of module names
533 public function getModules( $filter = false, $position = null, $param = 'mModules',
534 $type = ResourceLoaderModule
::TYPE_COMBINED
536 $modules = array_values( array_unique( $this->$param ) );
538 ?
$this->filterModules( $modules, null, $type )
543 * Load one or more ResourceLoader modules on this page.
545 * @param string|array $modules Module name (string) or array of module names
547 public function addModules( $modules ) {
548 $this->mModules
= array_merge( $this->mModules
, (array)$modules );
552 * @deprecated since 1.33 Use getModules() instead.
555 public function getModuleScripts() {
556 wfDeprecated( __METHOD__
, '1.33' );
561 * Get the list of style-only modules to load on this page.
563 * @param bool $filter
564 * @param string|null $position Unused
565 * @return array Array of module names
567 public function getModuleStyles( $filter = false, $position = null ) {
568 return $this->getModules( $filter, null, 'mModuleStyles',
569 ResourceLoaderModule
::TYPE_STYLES
574 * Load the styles of one or more ResourceLoader modules on this page.
576 * Module styles added through this function will be loaded as a stylesheet,
577 * using a standard `<link rel=stylesheet>` HTML tag, rather than as a combined
578 * Javascript and CSS package. Thus, they will even load when JavaScript is disabled.
580 * @param string|array $modules Module name (string) or array of module names
582 public function addModuleStyles( $modules ) {
583 $this->mModuleStyles
= array_merge( $this->mModuleStyles
, (array)$modules );
587 * @return null|string ResourceLoader target
589 public function getTarget() {
590 return $this->mTarget
;
594 * Sets ResourceLoader target for load.php links. If null, will be omitted
596 * @param string|null $target
598 public function setTarget( $target ) {
599 $this->mTarget
= $target;
603 * Add a mapping from a LinkTarget to a Content, for things like page preview.
604 * @see self::addContentOverrideCallback()
606 * @param LinkTarget $target
607 * @param Content $content
609 public function addContentOverride( LinkTarget
$target, Content
$content ) {
610 if ( !$this->contentOverrides
) {
611 // Register a callback for $this->contentOverrides on the first call
612 $this->addContentOverrideCallback( function ( LinkTarget
$target ) {
613 $key = $target->getNamespace() . ':' . $target->getDBkey();
614 return $this->contentOverrides
[$key] ??
null;
618 $key = $target->getNamespace() . ':' . $target->getDBkey();
619 $this->contentOverrides
[$key] = $content;
623 * Add a callback for mapping from a Title to a Content object, for things
625 * @see ResourceLoaderContext::getContentOverrideCallback()
627 * @param callable $callback
629 public function addContentOverrideCallback( callable
$callback ) {
630 $this->contentOverrideCallbacks
[] = $callback;
634 * Get an array of head items
638 function getHeadItemsArray() {
639 return $this->mHeadItems
;
643 * Add or replace a head item to the output
645 * Whenever possible, use more specific options like ResourceLoader modules,
646 * OutputPage::addLink(), OutputPage::addMetaLink() and OutputPage::addFeedLink()
647 * Fallback options for those are: OutputPage::addStyle, OutputPage::addScript(),
648 * OutputPage::addInlineScript() and OutputPage::addInlineStyle()
649 * This would be your very LAST fallback.
651 * @param string $name Item name
652 * @param string $value Raw HTML
654 public function addHeadItem( $name, $value ) {
655 $this->mHeadItems
[$name] = $value;
659 * Add one or more head items to the output
662 * @param string|string[] $values Raw HTML
664 public function addHeadItems( $values ) {
665 $this->mHeadItems
= array_merge( $this->mHeadItems
, (array)$values );
669 * Check if the header item $name is already set
671 * @param string $name Item name
674 public function hasHeadItem( $name ) {
675 return isset( $this->mHeadItems
[$name] );
679 * Add a class to the <body> element
682 * @param string|string[] $classes One or more classes to add
684 public function addBodyClasses( $classes ) {
685 $this->mAdditionalBodyClasses
= array_merge( $this->mAdditionalBodyClasses
, (array)$classes );
689 * Set whether the output should only contain the body of the article,
690 * without any skin, sidebar, etc.
691 * Used e.g. when calling with "action=render".
693 * @param bool $only Whether to output only the body of the article
695 public function setArticleBodyOnly( $only ) {
696 $this->mArticleBodyOnly
= $only;
700 * Return whether the output will contain only the body of the article
704 public function getArticleBodyOnly() {
705 return $this->mArticleBodyOnly
;
709 * Set an additional output property
712 * @param string $name
713 * @param mixed $value
715 public function setProperty( $name, $value ) {
716 $this->mProperties
[$name] = $value;
720 * Get an additional output property
723 * @param string $name
724 * @return mixed Property value or null if not found
726 public function getProperty( $name ) {
727 return $this->mProperties
[$name] ??
null;
731 * checkLastModified tells the client to use the client-cached page if
732 * possible. If successful, the OutputPage is disabled so that
733 * any future call to OutputPage->output() have no effect.
735 * Side effect: sets mLastModified for Last-Modified header
737 * @param string $timestamp
739 * @return bool True if cache-ok headers was sent.
741 public function checkLastModified( $timestamp ) {
742 if ( !$timestamp ||
$timestamp == '19700101000000' ) {
743 wfDebug( __METHOD__
. ": CACHE DISABLED, NO TIMESTAMP\n" );
746 $config = $this->getConfig();
747 if ( !$config->get( 'CachePages' ) ) {
748 wfDebug( __METHOD__
. ": CACHE DISABLED\n" );
752 $timestamp = wfTimestamp( TS_MW
, $timestamp );
754 'page' => $timestamp,
755 'user' => $this->getUser()->getTouched(),
756 'epoch' => $config->get( 'CacheEpoch' )
758 if ( $config->get( 'UseSquid' ) ) {
759 $modifiedTimes['sepoch'] = wfTimestamp( TS_MW
, $this->getCdnCacheEpoch(
761 $config->get( 'SquidMaxage' )
764 Hooks
::run( 'OutputPageCheckLastModified', [ &$modifiedTimes, $this ] );
766 $maxModified = max( $modifiedTimes );
767 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $maxModified );
769 $clientHeader = $this->getRequest()->getHeader( 'If-Modified-Since' );
770 if ( $clientHeader === false ) {
771 wfDebug( __METHOD__
. ": client did not send If-Modified-Since header", 'private' );
775 # IE sends sizes after the date like this:
776 # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
777 # this breaks strtotime().
778 $clientHeader = preg_replace( '/;.*$/', '', $clientHeader );
780 Wikimedia\
suppressWarnings(); // E_STRICT system time warnings
781 $clientHeaderTime = strtotime( $clientHeader );
782 Wikimedia\restoreWarnings
();
783 if ( !$clientHeaderTime ) {
785 . ": unable to parse the client's If-Modified-Since header: $clientHeader\n" );
788 $clientHeaderTime = wfTimestamp( TS_MW
, $clientHeaderTime );
792 foreach ( $modifiedTimes as $name => $value ) {
793 if ( $info !== '' ) {
796 $info .= "$name=" . wfTimestamp( TS_ISO_8601
, $value );
799 wfDebug( __METHOD__
. ": client sent If-Modified-Since: " .
800 wfTimestamp( TS_ISO_8601
, $clientHeaderTime ), 'private' );
801 wfDebug( __METHOD__
. ": effective Last-Modified: " .
802 wfTimestamp( TS_ISO_8601
, $maxModified ), 'private' );
803 if ( $clientHeaderTime < $maxModified ) {
804 wfDebug( __METHOD__
. ": STALE, $info", 'private' );
809 # Give a 304 Not Modified response code and disable body output
810 wfDebug( __METHOD__
. ": NOT MODIFIED, $info", 'private' );
811 ini_set( 'zlib.output_compression', 0 );
812 $this->getRequest()->response()->statusHeader( 304 );
813 $this->sendCacheControl();
816 // Don't output a compressed blob when using ob_gzhandler;
817 // it's technically against HTTP spec and seems to confuse
818 // Firefox when the response gets split over two packets.
819 wfClearOutputBuffers();
825 * @param int $reqTime Time of request (eg. now)
826 * @param int $maxAge Cache TTL in seconds
827 * @return int Timestamp
829 private function getCdnCacheEpoch( $reqTime, $maxAge ) {
830 // Ensure Last-Modified is never more than (wgSquidMaxage) in the past,
831 // because even if the wiki page content hasn't changed since, static
832 // resources may have changed (skin HTML, interface messages, urls, etc.)
833 // and must roll-over in a timely manner (T46570)
834 return $reqTime - $maxAge;
838 * Override the last modified timestamp
840 * @param string $timestamp New timestamp, in a format readable by
843 public function setLastModified( $timestamp ) {
844 $this->mLastModified
= wfTimestamp( TS_RFC2822
, $timestamp );
848 * Set the robot policy for the page: <http://www.robotstxt.org/meta.html>
850 * @param string $policy The literal string to output as the contents of
851 * the meta tag. Will be parsed according to the spec and output in
855 public function setRobotPolicy( $policy ) {
856 $policy = Article
::formatRobotPolicy( $policy );
858 if ( isset( $policy['index'] ) ) {
859 $this->setIndexPolicy( $policy['index'] );
861 if ( isset( $policy['follow'] ) ) {
862 $this->setFollowPolicy( $policy['follow'] );
867 * Set the index policy for the page, but leave the follow policy un-
870 * @param string $policy Either 'index' or 'noindex'.
873 public function setIndexPolicy( $policy ) {
874 $policy = trim( $policy );
875 if ( in_array( $policy, [ 'index', 'noindex' ] ) ) {
876 $this->mIndexPolicy
= $policy;
881 * Set the follow policy for the page, but leave the index policy un-
884 * @param string $policy Either 'follow' or 'nofollow'.
887 public function setFollowPolicy( $policy ) {
888 $policy = trim( $policy );
889 if ( in_array( $policy, [ 'follow', 'nofollow' ] ) ) {
890 $this->mFollowPolicy
= $policy;
895 * "HTML title" means the contents of "<title>".
896 * It is stored as plain, unescaped text and will be run through htmlspecialchars in the skin file.
898 * @param string|Message $name
900 public function setHTMLTitle( $name ) {
901 if ( $name instanceof Message
) {
902 $this->mHTMLtitle
= $name->setContext( $this->getContext() )->text();
904 $this->mHTMLtitle
= $name;
909 * Return the "HTML title", i.e. the content of the "<title>" tag.
913 public function getHTMLTitle() {
914 return $this->mHTMLtitle
;
918 * Set $mRedirectedFrom, the Title of the page which redirected us to the current page.
922 public function setRedirectedFrom( $t ) {
923 $this->mRedirectedFrom
= $t;
927 * "Page title" means the contents of \<h1\>. It is stored as a valid HTML
928 * fragment. This function allows good tags like \<sup\> in the \<h1\> tag,
929 * but not bad tags like \<script\>. This function automatically sets
930 * \<title\> to the same content as \<h1\> but with all tags removed. Bad
931 * tags that were escaped in \<h1\> will still be escaped in \<title\>, and
932 * good tags like \<i\> will be dropped entirely.
934 * @param string|Message $name
935 * @param-taint $name tainted
936 * Phan-taint-check gets very confused by $name being either a string or a Message
938 public function setPageTitle( $name ) {
939 if ( $name instanceof Message
) {
940 $name = $name->setContext( $this->getContext() )->text();
943 # change "<script>foo&bar</script>" to "<script>foo&bar</script>"
944 # but leave "<i>foobar</i>" alone
945 $nameWithTags = Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $name ) );
946 $this->mPageTitle
= $nameWithTags;
948 # change "<i>foo&bar</i>" to "foo&bar"
950 $this->msg( 'pagetitle' )->plaintextParams( Sanitizer
::stripAllTags( $nameWithTags ) )
951 ->inContentLanguage()
956 * Return the "page title", i.e. the content of the \<h1\> tag.
960 public function getPageTitle() {
961 return $this->mPageTitle
;
965 * Same as page title but only contains name of the page, not any other text.
968 * @param string $html Page title text.
969 * @see OutputPage::setPageTitle
971 public function setDisplayTitle( $html ) {
972 $this->displayTitle
= $html;
976 * Returns page display title.
978 * Performs some normalization, but this not as strict the magic word.
981 * @return string HTML
983 public function getDisplayTitle() {
984 $html = $this->displayTitle
;
985 if ( $html === null ) {
986 $html = $this->getTitle()->getPrefixedText();
989 return Sanitizer
::normalizeCharReferences( Sanitizer
::removeHTMLtags( $html ) );
993 * Returns page display title without namespace prefix if possible.
996 * @return string HTML
998 public function getUnprefixedDisplayTitle() {
999 $text = $this->getDisplayTitle();
1000 $nsPrefix = $this->getTitle()->getNsText() . ':';
1001 $prefix = preg_quote( $nsPrefix, '/' );
1003 return preg_replace( "/^$prefix/i", '', $text );
1007 * Set the Title object to use
1011 public function setTitle( Title
$t ) {
1012 $this->getContext()->setTitle( $t );
1016 * Replace the subtitle with $str
1018 * @param string|Message $str New value of the subtitle. String should be safe HTML.
1020 public function setSubtitle( $str ) {
1021 $this->clearSubtitle();
1022 $this->addSubtitle( $str );
1026 * Add $str to the subtitle
1028 * @param string|Message $str String or Message to add to the subtitle. String should be safe HTML.
1030 public function addSubtitle( $str ) {
1031 if ( $str instanceof Message
) {
1032 $this->mSubtitle
[] = $str->setContext( $this->getContext() )->parse();
1034 $this->mSubtitle
[] = $str;
1039 * Build message object for a subtitle containing a backlink to a page
1041 * @param Title $title Title to link to
1042 * @param array $query Array of additional parameters to include in the link
1046 public static function buildBacklinkSubtitle( Title
$title, $query = [] ) {
1047 if ( $title->isRedirect() ) {
1048 $query['redirect'] = 'no';
1050 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
1051 return wfMessage( 'backlinksubtitle' )
1052 ->rawParams( $linkRenderer->makeLink( $title, null, [], $query ) );
1056 * Add a subtitle containing a backlink to a page
1058 * @param Title $title Title to link to
1059 * @param array $query Array of additional parameters to include in the link
1061 public function addBacklinkSubtitle( Title
$title, $query = [] ) {
1062 $this->addSubtitle( self
::buildBacklinkSubtitle( $title, $query ) );
1066 * Clear the subtitles
1068 public function clearSubtitle() {
1069 $this->mSubtitle
= [];
1077 public function getSubtitle() {
1078 return implode( "<br />\n\t\t\t\t", $this->mSubtitle
);
1082 * Set the page as printable, i.e. it'll be displayed with all
1083 * print styles included
1085 public function setPrintable() {
1086 $this->mPrintable
= true;
1090 * Return whether the page is "printable"
1094 public function isPrintable() {
1095 return $this->mPrintable
;
1099 * Disable output completely, i.e. calling output() will have no effect
1101 public function disable() {
1102 $this->mDoNothing
= true;
1106 * Return whether the output will be completely disabled
1110 public function isDisabled() {
1111 return $this->mDoNothing
;
1115 * Show an "add new section" link?
1119 public function showNewSectionLink() {
1120 return $this->mNewSectionLink
;
1124 * Forcibly hide the new section link?
1128 public function forceHideNewSectionLink() {
1129 return $this->mHideNewSectionLink
;
1133 * Add or remove feed links in the page header
1134 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1135 * for the new version
1136 * @see addFeedLink()
1138 * @param bool $show True: add default feeds, false: remove all feeds
1140 public function setSyndicated( $show = true ) {
1142 $this->setFeedAppendQuery( false );
1144 $this->mFeedLinks
= [];
1149 * Add default feeds to the page header
1150 * This is mainly kept for backward compatibility, see OutputPage::addFeedLink()
1151 * for the new version
1152 * @see addFeedLink()
1154 * @param string $val Query to append to feed links or false to output
1157 public function setFeedAppendQuery( $val ) {
1158 $this->mFeedLinks
= [];
1160 foreach ( $this->getConfig()->get( 'AdvertisedFeedTypes' ) as $type ) {
1161 $query = "feed=$type";
1162 if ( is_string( $val ) ) {
1163 $query .= '&' . $val;
1165 $this->mFeedLinks
[$type] = $this->getTitle()->getLocalURL( $query );
1170 * Add a feed link to the page header
1172 * @param string $format Feed type, should be a key of $wgFeedClasses
1173 * @param string $href URL
1175 public function addFeedLink( $format, $href ) {
1176 if ( in_array( $format, $this->getConfig()->get( 'AdvertisedFeedTypes' ) ) ) {
1177 $this->mFeedLinks
[$format] = $href;
1182 * Should we output feed links for this page?
1185 public function isSyndicated() {
1186 return count( $this->mFeedLinks
) > 0;
1190 * Return URLs for each supported syndication format for this page.
1191 * @return array Associating format keys with URLs
1193 public function getSyndicationLinks() {
1194 return $this->mFeedLinks
;
1198 * Will currently always return null
1202 public function getFeedAppendQuery() {
1203 return $this->mFeedLinksAppendQuery
;
1207 * Set whether the displayed content is related to the source of the
1208 * corresponding article on the wiki
1209 * Setting true will cause the change "article related" toggle to true
1211 * @param bool $newVal
1213 public function setArticleFlag( $newVal ) {
1214 $this->mIsArticle
= $newVal;
1216 $this->mIsArticleRelated
= $newVal;
1221 * Return whether the content displayed page is related to the source of
1222 * the corresponding article on the wiki
1226 public function isArticle() {
1227 return $this->mIsArticle
;
1231 * Set whether this page is related an article on the wiki
1232 * Setting false will cause the change of "article flag" toggle to false
1234 * @param bool $newVal
1236 public function setArticleRelated( $newVal ) {
1237 $this->mIsArticleRelated
= $newVal;
1239 $this->mIsArticle
= false;
1244 * Return whether this page is related an article on the wiki
1248 public function isArticleRelated() {
1249 return $this->mIsArticleRelated
;
1253 * Set whether the standard copyright should be shown for the current page.
1255 * @param bool $hasCopyright
1257 public function setCopyright( $hasCopyright ) {
1258 $this->mHasCopyright
= $hasCopyright;
1262 * Return whether the standard copyright should be shown for the current page.
1263 * By default, it is true for all articles but other pages
1264 * can signal it by using setCopyright( true ).
1266 * Used by SkinTemplate to decided whether to show the copyright.
1270 public function showsCopyright() {
1271 return $this->isArticle() ||
$this->mHasCopyright
;
1275 * Add new language links
1277 * @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
1278 * (e.g. 'fr:Test page')
1280 public function addLanguageLinks( array $newLinkArray ) {
1281 $this->mLanguageLinks
= array_merge( $this->mLanguageLinks
, $newLinkArray );
1285 * Reset the language links and add new language links
1287 * @param string[] $newLinkArray Array of interwiki-prefixed (non DB key) titles
1288 * (e.g. 'fr:Test page')
1290 public function setLanguageLinks( array $newLinkArray ) {
1291 $this->mLanguageLinks
= $newLinkArray;
1295 * Get the list of language links
1297 * @return string[] Array of interwiki-prefixed (non DB key) titles (e.g. 'fr:Test page')
1299 public function getLanguageLinks() {
1300 return $this->mLanguageLinks
;
1304 * Add an array of categories, with names in the keys
1306 * @param array $categories Mapping category name => sort key
1308 public function addCategoryLinks( array $categories ) {
1309 if ( !$categories ) {
1313 $res = $this->addCategoryLinksToLBAndGetResult( $categories );
1315 # Set all the values to 'normal'.
1316 $categories = array_fill_keys( array_keys( $categories ), 'normal' );
1318 # Mark hidden categories
1319 foreach ( $res as $row ) {
1320 if ( isset( $row->pp_value
) ) {
1321 $categories[$row->page_title
] = 'hidden';
1325 // Avoid PHP 7.1 warning of passing $this by reference
1326 $outputPage = $this;
1327 # Add the remaining categories to the skin
1329 'OutputPageMakeCategoryLinks',
1330 [ &$outputPage, $categories, &$this->mCategoryLinks
] )
1332 $services = MediaWikiServices
::getInstance();
1333 $linkRenderer = $services->getLinkRenderer();
1334 foreach ( $categories as $category => $type ) {
1335 // array keys will cast numeric category names to ints, so cast back to string
1336 $category = (string)$category;
1337 $origcategory = $category;
1338 $title = Title
::makeTitleSafe( NS_CATEGORY
, $category );
1342 $services->getContentLanguage()->findVariantLink( $category, $title, true );
1343 if ( $category != $origcategory && array_key_exists( $category, $categories ) ) {
1346 $text = $services->getContentLanguage()->convertHtml( $title->getText() );
1347 $this->mCategories
[$type][] = $title->getText();
1348 $this->mCategoryLinks
[$type][] = $linkRenderer->makeLink( $title, new HtmlArmor( $text ) );
1354 * @param array $categories
1355 * @return bool|IResultWrapper
1357 protected function addCategoryLinksToLBAndGetResult( array $categories ) {
1358 # Add the links to a LinkBatch
1359 $arr = [ NS_CATEGORY
=> $categories ];
1360 $lb = new LinkBatch
;
1361 $lb->setArray( $arr );
1363 # Fetch existence plus the hiddencat property
1364 $dbr = wfGetDB( DB_REPLICA
);
1365 $fields = array_merge(
1366 LinkCache
::getSelectFields(),
1367 [ 'page_namespace', 'page_title', 'pp_value' ]
1370 $res = $dbr->select( [ 'page', 'page_props' ],
1372 $lb->constructSet( 'page', $dbr ),
1375 [ 'page_props' => [ 'LEFT JOIN', [
1376 'pp_propname' => 'hiddencat',
1381 # Add the results to the link cache
1382 $linkCache = MediaWikiServices
::getInstance()->getLinkCache();
1383 $lb->addResultToCache( $linkCache, $res );
1389 * Reset the category links (but not the category list) and add $categories
1391 * @param array $categories Mapping category name => sort key
1393 public function setCategoryLinks( array $categories ) {
1394 $this->mCategoryLinks
= [];
1395 $this->addCategoryLinks( $categories );
1399 * Get the list of category links, in a 2-D array with the following format:
1400 * $arr[$type][] = $link, where $type is either "normal" or "hidden" (for
1401 * hidden categories) and $link a HTML fragment with a link to the category
1406 public function getCategoryLinks() {
1407 return $this->mCategoryLinks
;
1411 * Get the list of category names this page belongs to.
1413 * @param string $type The type of categories which should be returned. Possible values:
1414 * * all: all categories of all types
1415 * * hidden: only the hidden categories
1416 * * normal: all categories, except hidden categories
1417 * @return array Array of strings
1419 public function getCategories( $type = 'all' ) {
1420 if ( $type === 'all' ) {
1421 $allCategories = [];
1422 foreach ( $this->mCategories
as $categories ) {
1423 $allCategories = array_merge( $allCategories, $categories );
1425 return $allCategories;
1427 if ( !isset( $this->mCategories
[$type] ) ) {
1428 throw new InvalidArgumentException( 'Invalid category type given: ' . $type );
1430 return $this->mCategories
[$type];
1434 * Add an array of indicators, with their identifiers as array
1435 * keys and HTML contents as values.
1437 * In case of duplicate keys, existing values are overwritten.
1439 * @param array $indicators
1442 public function setIndicators( array $indicators ) {
1443 $this->mIndicators
= $indicators +
$this->mIndicators
;
1444 // Keep ordered by key
1445 ksort( $this->mIndicators
);
1449 * Get the indicators associated with this page.
1451 * The array will be internally ordered by item keys.
1453 * @return array Keys: identifiers, values: HTML contents
1456 public function getIndicators() {
1457 return $this->mIndicators
;
1461 * Adds help link with an icon via page indicators.
1462 * Link target can be overridden by a local message containing a wikilink:
1463 * the message key is: lowercase action or special page name + '-helppage'.
1464 * @param string $to Target MediaWiki.org page title or encoded URL.
1465 * @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
1468 public function addHelpLink( $to, $overrideBaseUrl = false ) {
1469 $this->addModuleStyles( 'mediawiki.helplink' );
1470 $text = $this->msg( 'helppage-top-gethelp' )->escaped();
1472 if ( $overrideBaseUrl ) {
1475 $toUrlencoded = wfUrlencode( str_replace( ' ', '_', $to ) );
1476 $helpUrl = "//www.mediawiki.org/wiki/Special:MyLanguage/$toUrlencoded";
1479 $link = Html
::rawElement(
1483 'target' => '_blank',
1484 'class' => 'mw-helplink',
1489 $this->setIndicators( [ 'mw-helplink' => $link ] );
1493 * Do not allow scripts which can be modified by wiki users to load on this page;
1494 * only allow scripts bundled with, or generated by, the software.
1495 * Site-wide styles are controlled by a config setting, since they can be
1496 * used to create a custom skin/theme, but not user-specific ones.
1498 * @todo this should be given a more accurate name
1500 public function disallowUserJs() {
1501 $this->reduceAllowedModules(
1502 ResourceLoaderModule
::TYPE_SCRIPTS
,
1503 ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
1506 // Site-wide styles are controlled by a config setting, see T73621
1507 // for background on why. User styles are never allowed.
1508 if ( $this->getConfig()->get( 'AllowSiteCSSOnRestrictedPages' ) ) {
1509 $styleOrigin = ResourceLoaderModule
::ORIGIN_USER_SITEWIDE
;
1511 $styleOrigin = ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
;
1513 $this->reduceAllowedModules(
1514 ResourceLoaderModule
::TYPE_STYLES
,
1520 * Show what level of JavaScript / CSS untrustworthiness is allowed on this page
1521 * @see ResourceLoaderModule::$origin
1522 * @param string $type ResourceLoaderModule TYPE_ constant
1523 * @return int ResourceLoaderModule ORIGIN_ class constant
1525 public function getAllowedModules( $type ) {
1526 if ( $type == ResourceLoaderModule
::TYPE_COMBINED
) {
1527 return min( array_values( $this->mAllowedModules
) );
1529 return $this->mAllowedModules
[$type] ?? ResourceLoaderModule
::ORIGIN_ALL
;
1534 * Limit the highest level of CSS/JS untrustworthiness allowed.
1536 * If passed the same or a higher level than the current level of untrustworthiness set, the
1537 * level will remain unchanged.
1539 * @param string $type
1540 * @param int $level ResourceLoaderModule class constant
1542 public function reduceAllowedModules( $type, $level ) {
1543 $this->mAllowedModules
[$type] = min( $this->getAllowedModules( $type ), $level );
1547 * Prepend $text to the body HTML
1549 * @param string $text HTML
1551 public function prependHTML( $text ) {
1552 $this->mBodytext
= $text . $this->mBodytext
;
1556 * Append $text to the body HTML
1558 * @param string $text HTML
1560 public function addHTML( $text ) {
1561 $this->mBodytext
.= $text;
1565 * Shortcut for adding an Html::element via addHTML.
1569 * @param string $element
1570 * @param array $attribs
1571 * @param string $contents
1573 public function addElement( $element, array $attribs = [], $contents = '' ) {
1574 $this->addHTML( Html
::element( $element, $attribs, $contents ) );
1578 * Clear the body HTML
1580 public function clearHTML() {
1581 $this->mBodytext
= '';
1587 * @return string HTML
1589 public function getHTML() {
1590 return $this->mBodytext
;
1594 * Get/set the ParserOptions object to use for wikitext parsing
1596 * @param ParserOptions|null $options Either the ParserOption to use or null to only get the
1597 * current ParserOption object. This parameter is deprecated since 1.31.
1598 * @return ParserOptions
1600 public function parserOptions( $options = null ) {
1601 if ( $options !== null ) {
1602 wfDeprecated( __METHOD__
. ' with non-null $options', '1.31' );
1605 if ( $options !== null && !empty( $options->isBogus
) ) {
1606 // Someone is trying to set a bogus pre-$wgUser PO. Check if it has
1607 // been changed somehow, and keep it if so.
1608 $anonPO = ParserOptions
::newFromAnon();
1609 $anonPO->setAllowUnsafeRawHtml( false );
1610 if ( !$options->matches( $anonPO ) ) {
1611 wfLogWarning( __METHOD__
. ': Setting a changed bogus ParserOptions: ' . wfGetAllCallers( 5 ) );
1612 $options->isBogus
= false;
1616 if ( !$this->mParserOptions
) {
1617 if ( !$this->getContext()->getUser()->isSafeToLoad() ) {
1618 // $wgUser isn't unstubbable yet, so don't try to get a
1619 // ParserOptions for it. And don't cache this ParserOptions
1621 $po = ParserOptions
::newFromAnon();
1622 $po->setAllowUnsafeRawHtml( false );
1623 $po->isBogus
= true;
1624 if ( $options !== null ) {
1625 $this->mParserOptions
= empty( $options->isBogus
) ?
$options : null;
1630 $this->mParserOptions
= ParserOptions
::newFromContext( $this->getContext() );
1631 $this->mParserOptions
->setAllowUnsafeRawHtml( false );
1634 if ( $options !== null && !empty( $options->isBogus
) ) {
1635 // They're trying to restore the bogus pre-$wgUser PO. Do the right
1637 return wfSetVar( $this->mParserOptions
, null, true );
1639 return wfSetVar( $this->mParserOptions
, $options );
1644 * Set the revision ID which will be seen by the wiki text parser
1645 * for things such as embedded {{REVISIONID}} variable use.
1647 * @param int|null $revid A positive integer, or null
1648 * @return mixed Previous value
1650 public function setRevisionId( $revid ) {
1651 $val = is_null( $revid ) ?
null : intval( $revid );
1652 return wfSetVar( $this->mRevisionId
, $val, true );
1656 * Get the displayed revision ID
1660 public function getRevisionId() {
1661 return $this->mRevisionId
;
1665 * Set the timestamp of the revision which will be displayed. This is used
1666 * to avoid a extra DB call in Skin::lastModified().
1668 * @param string|null $timestamp
1669 * @return mixed Previous value
1671 public function setRevisionTimestamp( $timestamp ) {
1672 return wfSetVar( $this->mRevisionTimestamp
, $timestamp, true );
1676 * Get the timestamp of displayed revision.
1677 * This will be null if not filled by setRevisionTimestamp().
1679 * @return string|null
1681 public function getRevisionTimestamp() {
1682 return $this->mRevisionTimestamp
;
1686 * Set the displayed file version
1688 * @param File|null $file
1689 * @return mixed Previous value
1691 public function setFileVersion( $file ) {
1693 if ( $file instanceof File
&& $file->exists() ) {
1694 $val = [ 'time' => $file->getTimestamp(), 'sha1' => $file->getSha1() ];
1696 return wfSetVar( $this->mFileVersion
, $val, true );
1700 * Get the displayed file version
1702 * @return array|null ('time' => MW timestamp, 'sha1' => sha1)
1704 public function getFileVersion() {
1705 return $this->mFileVersion
;
1709 * Get the templates used on this page
1711 * @return array (namespace => dbKey => revId)
1714 public function getTemplateIds() {
1715 return $this->mTemplateIds
;
1719 * Get the files used on this page
1721 * @return array (dbKey => array('time' => MW timestamp or null, 'sha1' => sha1 or ''))
1724 public function getFileSearchOptions() {
1725 return $this->mImageTimeKeys
;
1729 * Convert wikitext to HTML and add it to the buffer
1730 * Default assumes that the current page title will be used.
1732 * @param string $text
1733 * @param bool $linestart Is this the start of a line?
1734 * @param bool $interface Is this text in the user interface language?
1735 * @throws MWException
1736 * @deprecated since 1.32 due to untidy output; use
1737 * addWikiTextAsInterface() if $interface is default value or true,
1738 * or else addWikiTextAsContent() if $interface is false.
1740 public function addWikiText( $text, $linestart = true, $interface = true ) {
1741 wfDeprecated( __METHOD__
, '1.32' );
1742 $title = $this->getTitle();
1744 throw new MWException( 'Title is null' );
1746 $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/false, $interface );
1750 * Convert wikitext *in the user interface language* to HTML and
1751 * add it to the buffer. The result will not be
1752 * language-converted, as user interface messages are already
1753 * localized into a specific variant. Assumes that the current
1754 * page title will be used if optional $title is not
1755 * provided. Output will be tidy.
1757 * @param string $text Wikitext in the user interface language
1758 * @param bool $linestart Is this the start of a line? (Defaults to true)
1759 * @param Title|null $title Optional title to use; default of `null`
1760 * means use current page title.
1761 * @throws MWException if $title is not provided and OutputPage::getTitle()
1765 public function addWikiTextAsInterface(
1766 $text, $linestart = true, Title
$title = null
1768 if ( $title === null ) {
1769 $title = $this->getTitle();
1772 throw new MWException( 'Title is null' );
1774 $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/true );
1778 * Convert wikitext *in the user interface language* to HTML and
1779 * add it to the buffer with a `<div class="$wrapperClass">`
1780 * wrapper. The result will not be language-converted, as user
1781 * interface messages as already localized into a specific
1782 * variant. The $text will be parsed in start-of-line context.
1783 * Output will be tidy.
1785 * @param string $wrapperClass The class attribute value for the <div>
1786 * wrapper in the output HTML
1787 * @param string $text Wikitext in the user interface language
1790 public function wrapWikiTextAsInterface(
1791 $wrapperClass, $text
1793 $this->addWikiTextTitleInternal(
1794 $text, $this->getTitle(),
1795 /*linestart*/true, /*tidy*/true, /*interface*/true,
1801 * Convert wikitext *in the page content language* to HTML and add
1802 * it to the buffer. The result with be language-converted to the
1803 * user's preferred variant. Assumes that the current page title
1804 * will be used if optional $title is not provided. Output will be
1807 * @param string $text Wikitext in the page content language
1808 * @param bool $linestart Is this the start of a line? (Defaults to true)
1809 * @param Title|null $title Optional title to use; default of `null`
1810 * means use current page title.
1811 * @throws MWException if $title is not provided and OutputPage::getTitle()
1815 public function addWikiTextAsContent(
1816 $text, $linestart = true, Title
$title = null
1818 if ( $title === null ) {
1819 $title = $this->getTitle();
1822 throw new MWException( 'Title is null' );
1824 $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/false );
1828 * Add wikitext with a custom Title object
1830 * @param string $text Wikitext
1831 * @param Title $title
1832 * @param bool $linestart Is this the start of a line?
1833 * @deprecated since 1.32 due to untidy output; use
1834 * addWikiTextAsInterface()
1836 public function addWikiTextWithTitle( $text, Title
$title, $linestart = true ) {
1837 wfDeprecated( __METHOD__
, '1.32' );
1838 $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/false, /*interface*/false );
1842 * Add wikitext *in content language* with a custom Title object.
1843 * Output will be tidy.
1845 * @param string $text Wikitext in content language
1846 * @param Title $title
1847 * @param bool $linestart Is this the start of a line?
1848 * @deprecated since 1.32 to rename methods consistently; use
1849 * addWikiTextAsContent()
1851 function addWikiTextTitleTidy( $text, Title
$title, $linestart = true ) {
1852 wfDeprecated( __METHOD__
, '1.32' );
1853 $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/false );
1857 * Add wikitext *in content language*. Output will be tidy.
1859 * @param string $text Wikitext in content language
1860 * @param bool $linestart Is this the start of a line?
1861 * @deprecated since 1.32 to rename methods consistently; use
1862 * addWikiTextAsContent()
1864 public function addWikiTextTidy( $text, $linestart = true ) {
1865 wfDeprecated( __METHOD__
, '1.32' );
1866 $title = $this->getTitle();
1868 throw new MWException( 'Title is null' );
1870 $this->addWikiTextTitleInternal( $text, $title, $linestart, /*tidy*/true, /*interface*/false );
1874 * Add wikitext with a custom Title object.
1875 * Output is unwrapped.
1877 * @param string $text Wikitext
1878 * @param Title $title
1879 * @param bool $linestart Is this the start of a line?
1880 * @param bool $tidy Whether to use tidy.
1881 * Setting this to false (or omitting it) is deprecated
1882 * since 1.32; all wikitext should be tidied.
1883 * For backwards-compatibility with prior MW releases,
1884 * you may wish to invoke this method but set $tidy=true;
1885 * this will result in equivalent output to the non-deprecated
1886 * addWikiTextAsContent()/addWikiTextAsInterface() methods.
1887 * @param bool $interface Whether it is an interface message
1888 * (for example disables conversion)
1889 * @deprecated since 1.32, use addWikiTextAsContent() or
1890 * addWikiTextAsInterface() (depending on $interface)
1892 public function addWikiTextTitle( $text, Title
$title, $linestart,
1893 $tidy = false, $interface = false
1895 wfDeprecated( __METHOD__
, '1.32' );
1896 return $this->addWikiTextTitleInternal( $text, $title, $linestart, $tidy, $interface );
1900 * Add wikitext with a custom Title object.
1901 * Output is unwrapped.
1903 * @param string $text Wikitext
1904 * @param Title $title
1905 * @param bool $linestart Is this the start of a line?
1906 * @param bool $tidy Whether to use tidy.
1907 * Setting this to false (or omitting it) is deprecated
1908 * since 1.32; all wikitext should be tidied.
1909 * @param bool $interface Whether it is an interface message
1910 * (for example disables conversion)
1911 * @param string $wrapperClass if not empty, wraps the output in
1912 * a `<div class="$wrapperClass">`
1915 private function addWikiTextTitleInternal(
1916 $text, Title
$title, $linestart, $tidy, $interface, $wrapperClass = null
1919 wfDeprecated( 'disabling tidy', '1.32' );
1922 $parserOutput = $this->parseInternal(
1923 $text, $title, $linestart, $tidy, $interface, /*language*/null
1926 $this->addParserOutput( $parserOutput, [
1927 'enableSectionEditLinks' => false,
1928 'wrapperDivClass' => $wrapperClass ??
'',
1933 * Add all metadata associated with a ParserOutput object, but without the actual HTML. This
1934 * includes categories, language links, ResourceLoader modules, effects of certain magic words,
1938 * @param ParserOutput $parserOutput
1940 public function addParserOutputMetadata( ParserOutput
$parserOutput ) {
1941 $this->mLanguageLinks
=
1942 array_merge( $this->mLanguageLinks
, $parserOutput->getLanguageLinks() );
1943 $this->addCategoryLinks( $parserOutput->getCategories() );
1944 $this->setIndicators( $parserOutput->getIndicators() );
1945 $this->mNewSectionLink
= $parserOutput->getNewSection();
1946 $this->mHideNewSectionLink
= $parserOutput->getHideNewSection();
1948 if ( !$parserOutput->isCacheable() ) {
1949 $this->enableClientCache( false );
1951 $this->mNoGallery
= $parserOutput->getNoGallery();
1952 $this->mHeadItems
= array_merge( $this->mHeadItems
, $parserOutput->getHeadItems() );
1953 $this->addModules( $parserOutput->getModules() );
1954 $this->addModuleStyles( $parserOutput->getModuleStyles() );
1955 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
1956 $this->mPreventClickjacking
= $this->mPreventClickjacking
1957 ||
$parserOutput->preventClickjacking();
1959 // Template versioning...
1960 foreach ( (array)$parserOutput->getTemplateIds() as $ns => $dbks ) {
1961 if ( isset( $this->mTemplateIds
[$ns] ) ) {
1962 $this->mTemplateIds
[$ns] = $dbks +
$this->mTemplateIds
[$ns];
1964 $this->mTemplateIds
[$ns] = $dbks;
1967 // File versioning...
1968 foreach ( (array)$parserOutput->getFileSearchOptions() as $dbk => $data ) {
1969 $this->mImageTimeKeys
[$dbk] = $data;
1972 // Hooks registered in the object
1973 $parserOutputHooks = $this->getConfig()->get( 'ParserOutputHooks' );
1974 foreach ( $parserOutput->getOutputHooks() as $hookInfo ) {
1975 list( $hookName, $data ) = $hookInfo;
1976 if ( isset( $parserOutputHooks[$hookName] ) ) {
1977 $parserOutputHooks[$hookName]( $this, $parserOutput, $data );
1981 // Enable OOUI if requested via ParserOutput
1982 if ( $parserOutput->getEnableOOUI() ) {
1983 $this->enableOOUI();
1986 // Include parser limit report
1987 if ( !$this->limitReportJSData
) {
1988 $this->limitReportJSData
= $parserOutput->getLimitReportJSData();
1991 // Link flags are ignored for now, but may in the future be
1992 // used to mark individual language links.
1994 // Avoid PHP 7.1 warning of passing $this by reference
1995 $outputPage = $this;
1996 Hooks
::run( 'LanguageLinks', [ $this->getTitle(), &$this->mLanguageLinks
, &$linkFlags ] );
1997 Hooks
::runWithoutAbort( 'OutputPageParserOutput', [ &$outputPage, $parserOutput ] );
1999 // This check must be after 'OutputPageParserOutput' runs in addParserOutputMetadata
2000 // so that extensions may modify ParserOutput to toggle TOC.
2001 // This cannot be moved to addParserOutputText because that is not
2002 // called by EditPage for Preview.
2003 if ( $parserOutput->getTOCHTML() ) {
2004 $this->mEnableTOC
= true;
2009 * Add the HTML and enhancements for it (like ResourceLoader modules) associated with a
2010 * ParserOutput object, without any other metadata.
2013 * @param ParserOutput $parserOutput
2014 * @param array $poOptions Options to ParserOutput::getText()
2016 public function addParserOutputContent( ParserOutput
$parserOutput, $poOptions = [] ) {
2017 $this->addParserOutputText( $parserOutput, $poOptions );
2019 $this->addModules( $parserOutput->getModules() );
2020 $this->addModuleStyles( $parserOutput->getModuleStyles() );
2022 $this->addJsConfigVars( $parserOutput->getJsConfigVars() );
2026 * Add the HTML associated with a ParserOutput object, without any metadata.
2029 * @param ParserOutput $parserOutput
2030 * @param array $poOptions Options to ParserOutput::getText()
2032 public function addParserOutputText( ParserOutput
$parserOutput, $poOptions = [] ) {
2033 $text = $parserOutput->getText( $poOptions );
2034 // Avoid PHP 7.1 warning of passing $this by reference
2035 $outputPage = $this;
2036 Hooks
::runWithoutAbort( 'OutputPageBeforeHTML', [ &$outputPage, &$text ] );
2037 $this->addHTML( $text );
2041 * Add everything from a ParserOutput object.
2043 * @param ParserOutput $parserOutput
2044 * @param array $poOptions Options to ParserOutput::getText()
2046 function addParserOutput( ParserOutput
$parserOutput, $poOptions = [] ) {
2047 $this->addParserOutputMetadata( $parserOutput );
2048 $this->addParserOutputText( $parserOutput, $poOptions );
2052 * Add the output of a QuickTemplate to the output buffer
2054 * @param QuickTemplate &$template
2056 public function addTemplate( &$template ) {
2057 $this->addHTML( $template->getHTML() );
2061 * Parse wikitext and return the HTML.
2063 * @todo The output is wrapped in a <div> iff $interface is false; it's
2064 * probably best to always strip the wrapper.
2066 * @param string $text
2067 * @param bool $linestart Is this the start of a line?
2068 * @param bool $interface Use interface language (instead of content language) while parsing
2069 * language sensitive magic words like GRAMMAR and PLURAL. This also disables
2070 * LanguageConverter.
2071 * @param Language|null $language Target language object, will override $interface
2072 * @throws MWException
2073 * @return string HTML
2074 * @deprecated since 1.32, due to untidy output and inconsistent wrapper;
2075 * use parseAsContent() if $interface is default value or false, or else
2076 * parseAsInterface() if $interface is true.
2078 public function parse( $text, $linestart = true, $interface = false, $language = null ) {
2079 wfDeprecated( __METHOD__
, '1.33' );
2080 return $this->parseInternal(
2081 $text, $this->getTitle(), $linestart, /*tidy*/false, $interface, $language
2083 'enableSectionEditLinks' => false,
2088 * Parse wikitext *in the page content language* and return the HTML.
2089 * The result will be language-converted to the user's preferred variant.
2090 * Output will be tidy.
2092 * @param string $text Wikitext in the page content language
2093 * @param bool $linestart Is this the start of a line? (Defaults to true)
2094 * @throws MWException
2095 * @return string HTML
2098 public function parseAsContent( $text, $linestart = true ) {
2099 return $this->parseInternal(
2100 $text, $this->getTitle(), $linestart, /*tidy*/true, /*interface*/false, /*language*/null
2102 'enableSectionEditLinks' => false,
2103 'wrapperDivClass' => ''
2108 * Parse wikitext *in the user interface language* and return the HTML.
2109 * The result will not be language-converted, as user interface messages
2110 * are already localized into a specific variant.
2111 * Output will be tidy.
2113 * @param string $text Wikitext in the user interface language
2114 * @param bool $linestart Is this the start of a line? (Defaults to true)
2115 * @throws MWException
2116 * @return string HTML
2119 public function parseAsInterface( $text, $linestart = true ) {
2120 return $this->parseInternal(
2121 $text, $this->getTitle(), $linestart, /*tidy*/true, /*interface*/true, /*language*/null
2123 'enableSectionEditLinks' => false,
2124 'wrapperDivClass' => ''
2129 * Parse wikitext *in the user interface language*, strip
2130 * paragraph wrapper, and return the HTML.
2131 * The result will not be language-converted, as user interface messages
2132 * are already localized into a specific variant.
2133 * Output will be tidy. Outer paragraph wrapper will only be stripped
2134 * if the result is a single paragraph.
2136 * @param string $text Wikitext in the user interface language
2137 * @param bool $linestart Is this the start of a line? (Defaults to true)
2138 * @throws MWException
2139 * @return string HTML
2142 public function parseInlineAsInterface( $text, $linestart = true ) {
2143 return Parser
::stripOuterParagraph(
2144 $this->parseAsInterface( $text, $linestart )
2149 * Parse wikitext, strip paragraph wrapper, and return the HTML.
2151 * @param string $text
2152 * @param bool $linestart Is this the start of a line?
2153 * @param bool $interface Use interface language (instead of content language) while parsing
2154 * language sensitive magic words like GRAMMAR and PLURAL
2155 * @return string HTML
2156 * @deprecated since 1.32, due to untidy output and confusing default
2157 * for $interface. Use parseInlineAsInterface() if $interface is
2158 * the default value or false, or else use
2159 * Parser::stripOuterParagraph($outputPage->parseAsContent(...)).
2161 public function parseInline( $text, $linestart = true, $interface = false ) {
2162 wfDeprecated( __METHOD__
, '1.33' );
2163 $parsed = $this->parseInternal(
2164 $text, $this->getTitle(), $linestart, /*tidy*/false, $interface, /*language*/null
2166 'enableSectionEditLinks' => false,
2167 'wrapperDivClass' => '', /* no wrapper div */
2169 return Parser
::stripOuterParagraph( $parsed );
2173 * Parse wikitext and return the HTML (internal implementation helper)
2175 * @param string $text
2176 * @param Title The title to use
2177 * @param bool $linestart Is this the start of a line?
2178 * @param bool $tidy Whether the output should be tidied
2179 * @param bool $interface Use interface language (instead of content language) while parsing
2180 * language sensitive magic words like GRAMMAR and PLURAL. This also disables
2181 * LanguageConverter.
2182 * @param Language|null $language Target language object, will override $interface
2183 * @throws MWException
2184 * @return ParserOutput
2186 private function parseInternal( $text, $title, $linestart, $tidy, $interface, $language ) {
2189 if ( is_null( $title ) ) {
2190 throw new MWException( 'Empty $mTitle in ' . __METHOD__
);
2193 $popts = $this->parserOptions();
2194 $oldTidy = $popts->setTidy( $tidy );
2195 $oldInterface = $popts->setInterfaceMessage( (bool)$interface );
2197 if ( $language !== null ) {
2198 $oldLang = $popts->setTargetLanguage( $language );
2201 $parserOutput = $wgParser->getFreshParser()->parse(
2202 $text, $title, $popts,
2203 $linestart, true, $this->mRevisionId
2206 $popts->setTidy( $oldTidy );
2207 $popts->setInterfaceMessage( $oldInterface );
2209 if ( $language !== null ) {
2210 $popts->setTargetLanguage( $oldLang );
2213 return $parserOutput;
2217 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header
2219 * @param int $maxage Maximum cache time on the CDN, in seconds.
2221 public function setCdnMaxage( $maxage ) {
2222 $this->mCdnMaxage
= min( $maxage, $this->mCdnMaxageLimit
);
2226 * Set the value of the "s-maxage" part of the "Cache-control" HTTP header to $maxage if that is
2227 * lower than the current s-maxage. Either way, $maxage is now an upper limit on s-maxage, so
2228 * that future calls to setCdnMaxage() will no longer be able to raise the s-maxage above
2231 * @param int $maxage Maximum cache time on the CDN, in seconds
2234 public function lowerCdnMaxage( $maxage ) {
2235 $this->mCdnMaxageLimit
= min( $maxage, $this->mCdnMaxageLimit
);
2236 $this->setCdnMaxage( $this->mCdnMaxage
);
2240 * Get TTL in [$minTTL,$maxTTL] in pass it to lowerCdnMaxage()
2242 * This sets and returns $minTTL if $mtime is false or null. Otherwise,
2243 * the TTL is higher the older the $mtime timestamp is. Essentially, the
2244 * TTL is 90% of the age of the object, subject to the min and max.
2246 * @param string|int|float|bool|null $mtime Last-Modified timestamp
2247 * @param int $minTTL Minimum TTL in seconds [default: 1 minute]
2248 * @param int $maxTTL Maximum TTL in seconds [default: $wgSquidMaxage]
2251 public function adaptCdnTTL( $mtime, $minTTL = 0, $maxTTL = 0 ) {
2252 $minTTL = $minTTL ?
: IExpiringStore
::TTL_MINUTE
;
2253 $maxTTL = $maxTTL ?
: $this->getConfig()->get( 'SquidMaxage' );
2255 if ( $mtime === null ||
$mtime === false ) {
2256 return $minTTL; // entity does not exist
2259 $age = MWTimestamp
::time() - wfTimestamp( TS_UNIX
, $mtime );
2260 $adaptiveTTL = max( 0.9 * $age, $minTTL );
2261 $adaptiveTTL = min( $adaptiveTTL, $maxTTL );
2263 $this->lowerCdnMaxage( (int)$adaptiveTTL );
2267 * Use enableClientCache(false) to force it to send nocache headers
2269 * @param bool|null $state New value, or null to not set the value
2271 * @return bool Old value
2273 public function enableClientCache( $state ) {
2274 return wfSetVar( $this->mEnableClientCache
, $state );
2278 * Get the list of cookie names that will influence the cache
2282 function getCacheVaryCookies() {
2283 if ( self
::$cacheVaryCookies === null ) {
2284 $config = $this->getConfig();
2285 self
::$cacheVaryCookies = array_values( array_unique( array_merge(
2286 SessionManager
::singleton()->getVaryCookies(),
2290 $config->get( 'CacheVaryCookies' )
2292 Hooks
::run( 'GetCacheVaryCookies', [ $this, &self
::$cacheVaryCookies ] );
2294 return self
::$cacheVaryCookies;
2298 * Check if the request has a cache-varying cookie header
2299 * If it does, it's very important that we don't allow public caching
2303 function haveCacheVaryCookies() {
2304 $request = $this->getRequest();
2305 foreach ( $this->getCacheVaryCookies() as $cookieName ) {
2306 if ( $request->getCookie( $cookieName, '', '' ) !== '' ) {
2307 wfDebug( __METHOD__
. ": found $cookieName\n" );
2311 wfDebug( __METHOD__
. ": no cache-varying cookies found\n" );
2316 * Add an HTTP header that will influence on the cache
2318 * @param string $header Header name
2319 * @param string[]|null $option Options for the Key header. See
2320 * https://datatracker.ietf.org/doc/draft-fielding-http-key/
2321 * for the list of valid options.
2323 public function addVaryHeader( $header, array $option = null ) {
2324 if ( !array_key_exists( $header, $this->mVaryHeader
) ) {
2325 $this->mVaryHeader
[$header] = [];
2327 if ( !is_array( $option ) ) {
2330 $this->mVaryHeader
[$header] =
2331 array_unique( array_merge( $this->mVaryHeader
[$header], $option ) );
2335 * Return a Vary: header on which to vary caches. Based on the keys of $mVaryHeader,
2336 * such as Accept-Encoding or Cookie
2340 public function getVaryHeader() {
2341 // If we vary on cookies, let's make sure it's always included here too.
2342 if ( $this->getCacheVaryCookies() ) {
2343 $this->addVaryHeader( 'Cookie' );
2346 foreach ( SessionManager
::singleton()->getVaryHeaders() as $header => $options ) {
2347 $this->addVaryHeader( $header, $options );
2349 return 'Vary: ' . implode( ', ', array_keys( $this->mVaryHeader
) );
2353 * Add an HTTP Link: header
2355 * @param string $header Header value
2357 public function addLinkHeader( $header ) {
2358 $this->mLinkHeader
[] = $header;
2362 * Return a Link: header. Based on the values of $mLinkHeader.
2366 public function getLinkHeader() {
2367 if ( !$this->mLinkHeader
) {
2371 return 'Link: ' . implode( ',', $this->mLinkHeader
);
2375 * Get a complete Key header
2378 * @deprecated in 1.32; the IETF spec for this header expired w/o becoming
2381 public function getKeyHeader() {
2382 wfDeprecated( '$wgUseKeyHeader', '1.32' );
2384 $cvCookies = $this->getCacheVaryCookies();
2386 $cookiesOption = [];
2387 foreach ( $cvCookies as $cookieName ) {
2388 $cookiesOption[] = 'param=' . $cookieName;
2390 $this->addVaryHeader( 'Cookie', $cookiesOption );
2392 foreach ( SessionManager
::singleton()->getVaryHeaders() as $header => $options ) {
2393 $this->addVaryHeader( $header, $options );
2397 foreach ( $this->mVaryHeader
as $header => $option ) {
2398 $newheader = $header;
2399 if ( is_array( $option ) && count( $option ) > 0 ) {
2400 $newheader .= ';' . implode( ';', $option );
2402 $headers[] = $newheader;
2404 $key = 'Key: ' . implode( ',', $headers );
2410 * T23672: Add Accept-Language to Vary and Key headers if there's no 'variant' parameter in GET.
2413 * /w/index.php?title=Main_page will vary based on Accept-Language; but
2414 * /w/index.php?title=Main_page&variant=zh-cn will not.
2416 private function addAcceptLanguage() {
2417 $title = $this->getTitle();
2418 if ( !$title instanceof Title
) {
2422 $lang = $title->getPageLanguage();
2423 if ( !$this->getRequest()->getCheck( 'variant' ) && $lang->hasVariants() ) {
2424 $variants = $lang->getVariants();
2426 foreach ( $variants as $variant ) {
2427 if ( $variant === $lang->getCode() ) {
2431 // XXX Note that this code is not strictly correct: we
2432 // do a case-insensitive match in
2433 // LanguageConverter::getHeaderVariant() while the
2434 // (abandoned, draft) spec for the `Key` header only
2435 // allows case-sensitive matches. To match the logic
2436 // in LanguageConverter::getHeaderVariant() we should
2437 // also be looking at fallback variants and deprecated
2438 // mediawiki-internal codes, as well as BCP 47
2439 // normalized forms.
2441 $aloption[] = "substr=$variant";
2443 // IE and some other browsers use BCP 47 standards in their Accept-Language header,
2444 // like "zh-CN" or "zh-Hant". We should handle these too.
2445 $variantBCP47 = LanguageCode
::bcp47( $variant );
2446 if ( $variantBCP47 !== $variant ) {
2447 $aloption[] = "substr=$variantBCP47";
2450 $this->addVaryHeader( 'Accept-Language', $aloption );
2455 * Set a flag which will cause an X-Frame-Options header appropriate for
2456 * edit pages to be sent. The header value is controlled by
2457 * $wgEditPageFrameOptions.
2459 * This is the default for special pages. If you display a CSRF-protected
2460 * form on an ordinary view page, then you need to call this function.
2462 * @param bool $enable
2464 public function preventClickjacking( $enable = true ) {
2465 $this->mPreventClickjacking
= $enable;
2469 * Turn off frame-breaking. Alias for $this->preventClickjacking(false).
2470 * This can be called from pages which do not contain any CSRF-protected
2473 public function allowClickjacking() {
2474 $this->mPreventClickjacking
= false;
2478 * Get the prevent-clickjacking flag
2483 public function getPreventClickjacking() {
2484 return $this->mPreventClickjacking
;
2488 * Get the X-Frame-Options header value (without the name part), or false
2489 * if there isn't one. This is used by Skin to determine whether to enable
2490 * JavaScript frame-breaking, for clients that don't support X-Frame-Options.
2492 * @return string|false
2494 public function getFrameOptions() {
2495 $config = $this->getConfig();
2496 if ( $config->get( 'BreakFrames' ) ) {
2498 } elseif ( $this->mPreventClickjacking
&& $config->get( 'EditPageFrameOptions' ) ) {
2499 return $config->get( 'EditPageFrameOptions' );
2505 * Get the Origin-Trial header values. This is used to enable Chrome Origin
2506 * Trials: https://github.com/GoogleChrome/OriginTrials
2510 private function getOriginTrials() {
2511 $config = $this->getConfig();
2513 return $config->get( 'OriginTrials' );
2517 * Send cache control HTTP headers
2519 public function sendCacheControl() {
2520 $response = $this->getRequest()->response();
2521 $config = $this->getConfig();
2523 $this->addVaryHeader( 'Cookie' );
2524 $this->addAcceptLanguage();
2526 # don't serve compressed data to clients who can't handle it
2527 # maintain different caches for logged-in users and non-logged in ones
2528 $response->header( $this->getVaryHeader() );
2530 if ( $config->get( 'UseKeyHeader' ) ) {
2531 $response->header( $this->getKeyHeader() );
2534 if ( $this->mEnableClientCache
) {
2536 $config->get( 'UseSquid' ) &&
2537 !$response->hasCookies() &&
2538 !SessionManager
::getGlobalSession()->isPersistent() &&
2539 !$this->isPrintable() &&
2540 $this->mCdnMaxage
!= 0 &&
2541 !$this->haveCacheVaryCookies()
2543 if ( $config->get( 'UseESI' ) ) {
2544 wfDeprecated( '$wgUseESI = true', '1.33' );
2545 # We'll purge the proxy cache explicitly, but require end user agents
2546 # to revalidate against the proxy on each visit.
2547 # Surrogate-Control controls our CDN, Cache-Control downstream caches
2548 wfDebug( __METHOD__
.
2549 ": proxy caching with ESI; {$this->mLastModified} **", 'private' );
2550 # start with a shorter timeout for initial testing
2551 # header( 'Surrogate-Control: max-age=2678400+2678400, content="ESI/1.0"');
2553 "Surrogate-Control: max-age={$config->get( 'SquidMaxage' )}" .
2554 "+{$this->mCdnMaxage}, content=\"ESI/1.0\""
2556 $response->header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
2558 # We'll purge the proxy cache for anons explicitly, but require end user agents
2559 # to revalidate against the proxy on each visit.
2560 # IMPORTANT! The CDN needs to replace the Cache-Control header with
2561 # Cache-Control: s-maxage=0, must-revalidate, max-age=0
2562 wfDebug( __METHOD__
.
2563 ": local proxy caching; {$this->mLastModified} **", 'private' );
2564 # start with a shorter timeout for initial testing
2565 # header( "Cache-Control: s-maxage=2678400, must-revalidate, max-age=0" );
2566 $response->header( "Cache-Control: " .
2567 "s-maxage={$this->mCdnMaxage}, must-revalidate, max-age=0" );
2570 # We do want clients to cache if they can, but they *must* check for updates
2571 # on revisiting the page.
2572 wfDebug( __METHOD__
. ": private caching; {$this->mLastModified} **", 'private' );
2573 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2574 $response->header( "Cache-Control: private, must-revalidate, max-age=0" );
2576 if ( $this->mLastModified
) {
2577 $response->header( "Last-Modified: {$this->mLastModified}" );
2580 wfDebug( __METHOD__
. ": no caching **", 'private' );
2582 # In general, the absence of a last modified header should be enough to prevent
2583 # the client from using its cache. We send a few other things just to make sure.
2584 $response->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
2585 $response->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
2586 $response->header( 'Pragma: no-cache' );
2591 * Transfer styles and JavaScript modules from skin.
2593 * @param Skin $sk to load modules for
2595 public function loadSkinModules( $sk ) {
2596 foreach ( $sk->getDefaultModules() as $group => $modules ) {
2597 if ( $group === 'styles' ) {
2598 foreach ( $modules as $key => $moduleMembers ) {
2599 $this->addModuleStyles( $moduleMembers );
2602 $this->addModules( $modules );
2608 * Finally, all the text has been munged and accumulated into
2609 * the object, let's actually output it:
2611 * @param bool $return Set to true to get the result as a string rather than sending it
2612 * @return string|null
2614 * @throws FatalError
2615 * @throws MWException
2617 public function output( $return = false ) {
2618 if ( $this->mDoNothing
) {
2619 return $return ?
'' : null;
2622 $response = $this->getRequest()->response();
2623 $config = $this->getConfig();
2625 if ( $this->mRedirect
!= '' ) {
2626 # Standards require redirect URLs to be absolute
2627 $this->mRedirect
= wfExpandUrl( $this->mRedirect
, PROTO_CURRENT
);
2629 $redirect = $this->mRedirect
;
2630 $code = $this->mRedirectCode
;
2632 if ( Hooks
::run( "BeforePageRedirect", [ $this, &$redirect, &$code ] ) ) {
2633 if ( $code == '301' ||
$code == '303' ) {
2634 if ( !$config->get( 'DebugRedirects' ) ) {
2635 $response->statusHeader( $code );
2637 $this->mLastModified
= wfTimestamp( TS_RFC2822
);
2639 if ( $config->get( 'VaryOnXFP' ) ) {
2640 $this->addVaryHeader( 'X-Forwarded-Proto' );
2642 $this->sendCacheControl();
2644 $response->header( "Content-Type: text/html; charset=utf-8" );
2645 if ( $config->get( 'DebugRedirects' ) ) {
2646 $url = htmlspecialchars( $redirect );
2647 print "<!DOCTYPE html>\n<html>\n<head>\n<title>Redirect</title>\n</head>\n<body>\n";
2648 print "<p>Location: <a href=\"$url\">$url</a></p>\n";
2649 print "</body>\n</html>\n";
2651 $response->header( 'Location: ' . $redirect );
2655 return $return ?
'' : null;
2656 } elseif ( $this->mStatusCode
) {
2657 $response->statusHeader( $this->mStatusCode
);
2660 # Buffer output; final headers may depend on later processing
2663 $response->header( 'Content-type: ' . $config->get( 'MimeType' ) . '; charset=UTF-8' );
2664 $response->header( 'Content-language: ' .
2665 MediaWikiServices
::getInstance()->getContentLanguage()->getHtmlCode() );
2667 if ( !$this->mArticleBodyOnly
) {
2668 $sk = $this->getSkin();
2671 $linkHeader = $this->getLinkHeader();
2672 if ( $linkHeader ) {
2673 $response->header( $linkHeader );
2676 // Prevent framing, if requested
2677 $frameOptions = $this->getFrameOptions();
2678 if ( $frameOptions ) {
2679 $response->header( "X-Frame-Options: $frameOptions" );
2682 $originTrials = $this->getOriginTrials();
2683 foreach ( $originTrials as $originTrial ) {
2684 $response->header( "Origin-Trial: $originTrial", false );
2687 ContentSecurityPolicy
::sendHeaders( $this );
2689 if ( $this->mArticleBodyOnly
) {
2690 echo $this->mBodytext
;
2692 // Enable safe mode if requested (T152169)
2693 if ( $this->getRequest()->getBool( 'safemode' ) ) {
2694 $this->disallowUserJs();
2697 $sk = $this->getSkin();
2698 $this->loadSkinModules( $sk );
2700 MWDebug
::addModules( $this );
2702 // Avoid PHP 7.1 warning of passing $this by reference
2703 $outputPage = $this;
2704 // Hook that allows last minute changes to the output page, e.g.
2705 // adding of CSS or Javascript by extensions.
2706 Hooks
::runWithoutAbort( 'BeforePageDisplay', [ &$outputPage, &$sk ] );
2710 } catch ( Exception
$e ) {
2711 ob_end_clean(); // bug T129657
2717 // This hook allows last minute changes to final overall output by modifying output buffer
2718 Hooks
::runWithoutAbort( 'AfterFinalPageOutput', [ $this ] );
2719 } catch ( Exception
$e ) {
2720 ob_end_clean(); // bug T129657
2724 $this->sendCacheControl();
2727 return ob_get_clean();
2735 * Prepare this object to display an error page; disable caching and
2736 * indexing, clear the current text and redirect, set the page's title
2737 * and optionally an custom HTML title (content of the "<title>" tag).
2739 * @param string|Message $pageTitle Will be passed directly to setPageTitle()
2740 * @param string|Message $htmlTitle Will be passed directly to setHTMLTitle();
2741 * optional, if not passed the "<title>" attribute will be
2742 * based on $pageTitle
2744 public function prepareErrorPage( $pageTitle, $htmlTitle = false ) {
2745 $this->setPageTitle( $pageTitle );
2746 if ( $htmlTitle !== false ) {
2747 $this->setHTMLTitle( $htmlTitle );
2749 $this->setRobotPolicy( 'noindex,nofollow' );
2750 $this->setArticleRelated( false );
2751 $this->enableClientCache( false );
2752 $this->mRedirect
= '';
2753 $this->clearSubtitle();
2758 * Output a standard error page
2760 * showErrorPage( 'titlemsg', 'pagetextmsg' );
2761 * showErrorPage( 'titlemsg', 'pagetextmsg', [ 'param1', 'param2' ] );
2762 * showErrorPage( 'titlemsg', $messageObject );
2763 * showErrorPage( $titleMessageObject, $messageObject );
2765 * @param string|Message $title Message key (string) for page title, or a Message object
2766 * @param string|Message $msg Message key (string) for page text, or a Message object
2767 * @param array $params Message parameters; ignored if $msg is a Message object
2769 public function showErrorPage( $title, $msg, $params = [] ) {
2770 if ( !$title instanceof Message
) {
2771 $title = $this->msg( $title );
2774 $this->prepareErrorPage( $title );
2776 if ( $msg instanceof Message
) {
2777 if ( $params !== [] ) {
2778 trigger_error( 'Argument ignored: $params. The message parameters argument '
2779 . 'is discarded when the $msg argument is a Message object instead of '
2780 . 'a string.', E_USER_NOTICE
);
2782 $this->addHTML( $msg->parseAsBlock() );
2784 $this->addWikiMsgArray( $msg, $params );
2787 $this->returnToMain();
2791 * Output a standard permission error page
2793 * @param array $errors Error message keys or [key, param...] arrays
2794 * @param string|null $action Action that was denied or null if unknown
2796 public function showPermissionsErrorPage( array $errors, $action = null ) {
2797 foreach ( $errors as $key => $error ) {
2798 $errors[$key] = (array)$error;
2801 // For some action (read, edit, create and upload), display a "login to do this action"
2802 // error if all of the following conditions are met:
2803 // 1. the user is not logged in
2804 // 2. the only error is insufficient permissions (i.e. no block or something else)
2805 // 3. the error can be avoided simply by logging in
2806 if ( in_array( $action, [ 'read', 'edit', 'createpage', 'createtalk', 'upload' ] )
2807 && $this->getUser()->isAnon() && count( $errors ) == 1 && isset( $errors[0][0] )
2808 && ( $errors[0][0] == 'badaccess-groups' ||
$errors[0][0] == 'badaccess-group0' )
2809 && ( User
::groupHasPermission( 'user', $action )
2810 || User
::groupHasPermission( 'autoconfirmed', $action ) )
2812 $displayReturnto = null;
2814 # Due to T34276, if a user does not have read permissions,
2815 # $this->getTitle() will just give Special:Badtitle, which is
2816 # not especially useful as a returnto parameter. Use the title
2817 # from the request instead, if there was one.
2818 $request = $this->getRequest();
2819 $returnto = Title
::newFromText( $request->getVal( 'title', '' ) );
2820 if ( $action == 'edit' ) {
2821 $msg = 'whitelistedittext';
2822 $displayReturnto = $returnto;
2823 } elseif ( $action == 'createpage' ||
$action == 'createtalk' ) {
2824 $msg = 'nocreatetext';
2825 } elseif ( $action == 'upload' ) {
2826 $msg = 'uploadnologintext';
2828 $msg = 'loginreqpagetext';
2829 $displayReturnto = Title
::newMainPage();
2835 $query['returnto'] = $returnto->getPrefixedText();
2837 if ( !$request->wasPosted() ) {
2838 $returntoquery = $request->getValues();
2839 unset( $returntoquery['title'] );
2840 unset( $returntoquery['returnto'] );
2841 unset( $returntoquery['returntoquery'] );
2842 $query['returntoquery'] = wfArrayToCgi( $returntoquery );
2845 $title = SpecialPage
::getTitleFor( 'Userlogin' );
2846 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
2847 $loginUrl = $title->getLinkURL( $query, false, PROTO_RELATIVE
);
2848 $loginLink = $linkRenderer->makeKnownLink(
2850 $this->msg( 'loginreqlink' )->text(),
2855 $this->prepareErrorPage( $this->msg( 'loginreqtitle' ) );
2856 $this->addHTML( $this->msg( $msg )->rawParams( $loginLink )->params( $loginUrl )->parse() );
2858 # Don't return to a page the user can't read otherwise
2859 # we'll end up in a pointless loop
2860 if ( $displayReturnto && $displayReturnto->userCan( 'read', $this->getUser() ) ) {
2861 $this->returnToMain( null, $displayReturnto );
2864 $this->prepareErrorPage( $this->msg( 'permissionserrors' ) );
2865 $this->addWikiTextAsInterface( $this->formatPermissionsErrorMessage( $errors, $action ) );
2870 * Display an error page indicating that a given version of MediaWiki is
2871 * required to use it
2873 * @param mixed $version The version of MediaWiki needed to use the page
2875 public function versionRequired( $version ) {
2876 $this->prepareErrorPage( $this->msg( 'versionrequired', $version ) );
2878 $this->addWikiMsg( 'versionrequiredtext', $version );
2879 $this->returnToMain();
2883 * Format a list of error messages
2885 * @param array $errors Array of arrays returned by Title::getUserPermissionsErrors
2886 * @param string|null $action Action that was denied or null if unknown
2887 * @return string The wikitext error-messages, formatted into a list.
2889 public function formatPermissionsErrorMessage( array $errors, $action = null ) {
2890 if ( $action == null ) {
2891 $text = $this->msg( 'permissionserrorstext', count( $errors ) )->plain() . "\n\n";
2893 $action_desc = $this->msg( "action-$action" )->plain();
2895 'permissionserrorstext-withaction',
2898 )->plain() . "\n\n";
2901 if ( count( $errors ) > 1 ) {
2902 $text .= '<ul class="permissions-errors">' . "\n";
2904 foreach ( $errors as $error ) {
2906 $text .= $this->msg( ...$error )->plain();
2911 $text .= "<div class=\"permissions-errors\">\n" .
2912 $this->msg( ...reset( $errors ) )->plain() .
2920 * Show a warning about replica DB lag
2922 * If the lag is higher than $wgSlaveLagCritical seconds,
2923 * then the warning is a bit more obvious. If the lag is
2924 * lower than $wgSlaveLagWarning, then no warning is shown.
2926 * @param int $lag Replica lag
2928 public function showLagWarning( $lag ) {
2929 $config = $this->getConfig();
2930 if ( $lag >= $config->get( 'SlaveLagWarning' ) ) {
2931 $lag = floor( $lag ); // floor to avoid nano seconds to display
2932 $message = $lag < $config->get( 'SlaveLagCritical' )
2935 $wrap = Html
::rawElement( 'div', [ 'class' => "mw-{$message}" ], "\n$1\n" );
2936 $this->wrapWikiMsg( "$wrap\n", [ $message, $this->getLanguage()->formatNum( $lag ) ] );
2941 * Output an error page
2943 * @note FatalError exception class provides an alternative.
2944 * @param string $message Error to output. Must be escaped for HTML.
2946 public function showFatalError( $message ) {
2947 $this->prepareErrorPage( $this->msg( 'internalerror' ) );
2949 $this->addHTML( $message );
2953 * @deprecated 1.32 Use OutputPage::showFatalError or throw FatalError instead.
2955 public function showUnexpectedValueError( $name, $val ) {
2956 wfDeprecated( __METHOD__
, '1.32' );
2957 $this->showFatalError( $this->msg( 'unexpected', $name, $val )->escaped() );
2961 * @deprecated 1.32 Use OutputPage::showFatalError or throw FatalError instead.
2963 public function showFileCopyError( $old, $new ) {
2964 wfDeprecated( __METHOD__
, '1.32' );
2965 $this->showFatalError( $this->msg( 'filecopyerror', $old, $new )->escaped() );
2969 * @deprecated 1.32 Use OutputPage::showFatalError or throw FatalError instead.
2971 public function showFileRenameError( $old, $new ) {
2972 wfDeprecated( __METHOD__
, '1.32' );
2973 $this->showFatalError( $this->msg( 'filerenameerror', $old, $new )->escpaed() );
2977 * @deprecated 1.32 Use OutputPage::showFatalError or throw FatalError instead.
2979 public function showFileDeleteError( $name ) {
2980 wfDeprecated( __METHOD__
, '1.32' );
2981 $this->showFatalError( $this->msg( 'filedeleteerror', $name )->escaped() );
2985 * @deprecated 1.32 Use OutputPage::showFatalError or throw FatalError instead.
2987 public function showFileNotFoundError( $name ) {
2988 wfDeprecated( __METHOD__
, '1.32' );
2989 $this->showFatalError( $this->msg( 'filenotfound', $name )->escaped() );
2993 * Add a "return to" link pointing to a specified title
2995 * @param Title $title Title to link
2996 * @param array $query Query string parameters
2997 * @param string|null $text Text of the link (input is not escaped)
2998 * @param array $options Options array to pass to Linker
3000 public function addReturnTo( $title, array $query = [], $text = null, $options = [] ) {
3001 $linkRenderer = MediaWikiServices
::getInstance()
3002 ->getLinkRendererFactory()->createFromLegacyOptions( $options );
3003 $link = $this->msg( 'returnto' )->rawParams(
3004 $linkRenderer->makeLink( $title, $text, [], $query ) )->escaped();
3005 $this->addHTML( "<p id=\"mw-returnto\">{$link}</p>\n" );
3009 * Add a "return to" link pointing to a specified title,
3010 * or the title indicated in the request, or else the main page
3012 * @param mixed|null $unused
3013 * @param Title|string|null $returnto Title or String to return to
3014 * @param string|null $returntoquery Query string for the return to link
3016 public function returnToMain( $unused = null, $returnto = null, $returntoquery = null ) {
3017 if ( $returnto == null ) {
3018 $returnto = $this->getRequest()->getText( 'returnto' );
3021 if ( $returntoquery == null ) {
3022 $returntoquery = $this->getRequest()->getText( 'returntoquery' );
3025 if ( $returnto === '' ) {
3026 $returnto = Title
::newMainPage();
3029 if ( is_object( $returnto ) ) {
3030 $titleObj = $returnto;
3032 $titleObj = Title
::newFromText( $returnto );
3034 // We don't want people to return to external interwiki. That
3035 // might potentially be used as part of a phishing scheme
3036 if ( !is_object( $titleObj ) ||
$titleObj->isExternal() ) {
3037 $titleObj = Title
::newMainPage();
3040 $this->addReturnTo( $titleObj, wfCgiToArray( $returntoquery ) );
3043 private function getRlClientContext() {
3044 if ( !$this->rlClientContext
) {
3045 $query = ResourceLoader
::makeLoaderQuery(
3046 [], // modules; not relevant
3047 $this->getLanguage()->getCode(),
3048 $this->getSkin()->getSkinName(),
3049 $this->getUser()->isLoggedIn() ?
$this->getUser()->getName() : null,
3050 null, // version; not relevant
3051 ResourceLoader
::inDebugMode(),
3052 null, // only; not relevant
3053 $this->isPrintable(),
3054 $this->getRequest()->getBool( 'handheld' )
3056 $this->rlClientContext
= new ResourceLoaderContext(
3057 $this->getResourceLoader(),
3058 new FauxRequest( $query )
3060 if ( $this->contentOverrideCallbacks
) {
3061 $this->rlClientContext
= new DerivativeResourceLoaderContext( $this->rlClientContext
);
3062 $this->rlClientContext
->setContentOverrideCallback( function ( Title
$title ) {
3063 foreach ( $this->contentOverrideCallbacks
as $callback ) {
3064 $content = $callback( $title );
3065 if ( $content !== null ) {
3066 $text = ContentHandler
::getContentText( $content );
3067 if ( strpos( $text, '</script>' ) !== false ) {
3068 // Proactively replace this so that we can display a message
3069 // to the user, instead of letting it go to Html::inlineScript(),
3070 // where it would be considered a server-side issue.
3071 $titleFormatted = $title->getPrefixedText();
3072 $content = new JavaScriptContent(
3073 Xml
::encodeJsCall( 'mw.log.error', [
3074 "Cannot preview $titleFormatted due to script-closing tag."
3085 return $this->rlClientContext
;
3089 * Call this to freeze the module queue and JS config and create a formatter.
3091 * Depending on the Skin, this may get lazy-initialised in either headElement() or
3092 * getBottomScripts(). See SkinTemplate::prepareQuickTemplate(). Calling this too early may
3093 * cause unexpected side-effects since disallowUserJs() may be called at any time to change
3094 * the module filters retroactively. Skins and extension hooks may also add modules until very
3095 * late in the request lifecycle.
3097 * @return ResourceLoaderClientHtml
3099 public function getRlClient() {
3100 if ( !$this->rlClient
) {
3101 $context = $this->getRlClientContext();
3102 $rl = $this->getResourceLoader();
3103 $this->addModules( [
3108 $this->addModuleStyles( [
3113 $this->getSkin()->setupSkinUserCss( $this );
3115 // Prepare exempt modules for buildExemptModules()
3116 $exemptGroups = [ 'site' => [], 'noscript' => [], 'private' => [], 'user' => [] ];
3118 $moduleStyles = $this->getModuleStyles( /*filter*/ true );
3120 // Preload getTitleInfo for isKnownEmpty calls below and in ResourceLoaderClientHtml
3121 // Separate user-specific batch for improved cache-hit ratio.
3122 $userBatch = [ 'user.styles', 'user' ];
3123 $siteBatch = array_diff( $moduleStyles, $userBatch );
3124 $dbr = wfGetDB( DB_REPLICA
);
3125 ResourceLoaderWikiModule
::preloadTitleInfo( $context, $dbr, $siteBatch );
3126 ResourceLoaderWikiModule
::preloadTitleInfo( $context, $dbr, $userBatch );
3128 // Filter out modules handled by buildExemptModules()
3129 $moduleStyles = array_filter( $moduleStyles,
3130 function ( $name ) use ( $rl, $context, &$exemptGroups, &$exemptStates ) {
3131 $module = $rl->getModule( $name );
3133 $group = $module->getGroup();
3134 if ( isset( $exemptGroups[$group] ) ) {
3135 $exemptStates[$name] = 'ready';
3136 if ( !$module->isKnownEmpty( $context ) ) {
3137 // E.g. Don't output empty <styles>
3138 $exemptGroups[$group][] = $name;
3146 $this->rlExemptStyleModules
= $exemptGroups;
3148 $rlClient = new ResourceLoaderClientHtml( $context, [
3149 'target' => $this->getTarget(),
3150 'nonce' => $this->getCSPNonce(),
3151 // When 'safemode', disallowUserJs(), or reduceAllowedModules() is used
3152 // to only restrict modules to ORIGIN_CORE (ie. disallow ORIGIN_USER), the list of
3153 // modules enqueud for loading on this page is filtered to just those.
3154 // However, to make sure we also apply the restriction to dynamic dependencies and
3155 // lazy-loaded modules at run-time on the client-side, pass 'safemode' down to the
3156 // StartupModule so that the client-side registry will not contain any restricted
3157 // modules either. (T152169, T185303)
3158 'safemode' => ( $this->getAllowedModules( ResourceLoaderModule
::TYPE_COMBINED
)
3159 <= ResourceLoaderModule
::ORIGIN_CORE_INDIVIDUAL
3162 $rlClient->setConfig( $this->getJSVars() );
3163 $rlClient->setModules( $this->getModules( /*filter*/ true ) );
3164 $rlClient->setModuleStyles( $moduleStyles );
3165 $rlClient->setExemptStates( $exemptStates );
3166 $this->rlClient
= $rlClient;
3168 return $this->rlClient
;
3172 * @param Skin $sk The given Skin
3173 * @param bool $includeStyle Unused
3174 * @return string The doctype, opening "<html>", and head element.
3176 public function headElement( Skin
$sk, $includeStyle = true ) {
3177 $userdir = $this->getLanguage()->getDir();
3178 $sitedir = MediaWikiServices
::getInstance()->getContentLanguage()->getDir();
3181 $pieces[] = Html
::htmlHeader( Sanitizer
::mergeAttributes(
3182 $this->getRlClient()->getDocumentAttributes(),
3183 $sk->getHtmlElementAttributes()
3185 $pieces[] = Html
::openElement( 'head' );
3187 if ( $this->getHTMLTitle() == '' ) {
3188 $this->setHTMLTitle( $this->msg( 'pagetitle', $this->getPageTitle() )->inContentLanguage() );
3191 if ( !Html
::isXmlMimeType( $this->getConfig()->get( 'MimeType' ) ) ) {
3192 // Add <meta charset="UTF-8">
3193 // This should be before <title> since it defines the charset used by
3194 // text including the text inside <title>.
3195 // The spec recommends defining XHTML5's charset using the XML declaration
3197 // Our XML declaration is output by Html::htmlHeader.
3198 // https://html.spec.whatwg.org/multipage/semantics.html#attr-meta-http-equiv-content-type
3199 // https://html.spec.whatwg.org/multipage/semantics.html#charset
3200 $pieces[] = Html
::element( 'meta', [ 'charset' => 'UTF-8' ] );
3203 $pieces[] = Html
::element( 'title', null, $this->getHTMLTitle() );
3204 $pieces[] = $this->getRlClient()->getHeadHtml();
3205 $pieces[] = $this->buildExemptModules();
3206 $pieces = array_merge( $pieces, array_values( $this->getHeadLinksArray() ) );
3207 $pieces = array_merge( $pieces, array_values( $this->mHeadItems
) );
3209 // Use an IE conditional comment to serve the script only to old IE
3210 $pieces[] = '<!--[if lt IE 9]>' .
3211 ResourceLoaderClientHtml
::makeLoad(
3212 ResourceLoaderContext
::newDummyContext(),
3214 ResourceLoaderModule
::TYPE_SCRIPTS
,
3216 $this->getCSPNonce()
3220 $pieces[] = Html
::closeElement( 'head' );
3222 $bodyClasses = $this->mAdditionalBodyClasses
;
3223 $bodyClasses[] = 'mediawiki';
3225 # Classes for LTR/RTL directionality support
3226 $bodyClasses[] = $userdir;
3227 $bodyClasses[] = "sitedir-$sitedir";
3229 $underline = $this->getUser()->getOption( 'underline' );
3230 if ( $underline < 2 ) {
3231 // The following classes can be used here:
3232 // * mw-underline-always
3233 // * mw-underline-never
3234 $bodyClasses[] = 'mw-underline-' . ( $underline ?
'always' : 'never' );
3237 if ( $this->getLanguage()->capitalizeAllNouns() ) {
3238 # A <body> class is probably not the best way to do this . . .
3239 $bodyClasses[] = 'capitalize-all-nouns';
3242 // Parser feature migration class
3243 // The idea is that this will eventually be removed, after the wikitext
3244 // which requires it is cleaned up.
3245 $bodyClasses[] = 'mw-hide-empty-elt';
3247 $bodyClasses[] = $sk->getPageClasses( $this->getTitle() );
3248 $bodyClasses[] = 'skin-' . Sanitizer
::escapeClass( $sk->getSkinName() );
3250 'action-' . Sanitizer
::escapeClass( Action
::getActionName( $this->getContext() ) );
3253 // While the implode() is not strictly needed, it's used for backwards compatibility
3254 // (this used to be built as a string and hooks likely still expect that).
3255 $bodyAttrs['class'] = implode( ' ', $bodyClasses );
3257 // Allow skins and extensions to add body attributes they need
3258 $sk->addToBodyAttributes( $this, $bodyAttrs );
3259 Hooks
::run( 'OutputPageBodyAttributes', [ $this, $sk, &$bodyAttrs ] );
3261 $pieces[] = Html
::openElement( 'body', $bodyAttrs );
3263 return self
::combineWrappedStrings( $pieces );
3267 * Get a ResourceLoader object associated with this OutputPage
3269 * @return ResourceLoader
3271 public function getResourceLoader() {
3272 if ( is_null( $this->mResourceLoader
) ) {
3273 // Lazy-initialise as needed
3274 $this->mResourceLoader
= MediaWikiServices
::getInstance()->getResourceLoader();
3276 return $this->mResourceLoader
;
3280 * Explicily load or embed modules on a page.
3282 * @param array|string $modules One or more module names
3283 * @param string $only ResourceLoaderModule TYPE_ class constant
3284 * @param array $extraQuery [optional] Array with extra query parameters for the request
3285 * @return string|WrappedStringList HTML
3287 public function makeResourceLoaderLink( $modules, $only, array $extraQuery = [] ) {
3288 // Apply 'target' and 'origin' filters
3289 $modules = $this->filterModules( (array)$modules, null, $only );
3291 return ResourceLoaderClientHtml
::makeLoad(
3292 $this->getRlClientContext(),
3296 $this->getCSPNonce()
3301 * Combine WrappedString chunks and filter out empty ones
3303 * @param array $chunks
3304 * @return string|WrappedStringList HTML
3306 protected static function combineWrappedStrings( array $chunks ) {
3307 // Filter out empty values
3308 $chunks = array_filter( $chunks, 'strlen' );
3309 return WrappedString
::join( "\n", $chunks );
3313 * JS stuff to put at the bottom of the `<body>`.
3314 * These are legacy scripts ($this->mScripts), and user JS.
3316 * @return string|WrappedStringList HTML
3318 public function getBottomScripts() {
3320 $chunks[] = $this->getRlClient()->getBodyHtml();
3322 // Legacy non-ResourceLoader scripts
3323 $chunks[] = $this->mScripts
;
3325 if ( $this->limitReportJSData
) {
3326 $chunks[] = ResourceLoader
::makeInlineScript(
3327 ResourceLoader
::makeConfigSetScript(
3328 [ 'wgPageParseReport' => $this->limitReportJSData
]
3330 $this->getCSPNonce()
3334 return self
::combineWrappedStrings( $chunks );
3338 * Get the javascript config vars to include on this page
3340 * @return array Array of javascript config vars
3343 public function getJsConfigVars() {
3344 return $this->mJsConfigVars
;
3348 * Add one or more variables to be set in mw.config in JavaScript
3350 * @param string|array $keys Key or array of key/value pairs
3351 * @param mixed|null $value [optional] Value of the configuration variable
3353 public function addJsConfigVars( $keys, $value = null ) {
3354 if ( is_array( $keys ) ) {
3355 foreach ( $keys as $key => $value ) {
3356 $this->mJsConfigVars
[$key] = $value;
3361 $this->mJsConfigVars
[$keys] = $value;
3365 * Get an array containing the variables to be set in mw.config in JavaScript.
3367 * Do not add things here which can be evaluated in ResourceLoaderStartUpModule
3368 * - in other words, page-independent/site-wide variables (without state).
3369 * You will only be adding bloat to the html page and causing page caches to
3370 * have to be purged on configuration changes.
3373 public function getJSVars() {
3376 $canonicalSpecialPageName = false; # T23115
3377 $services = MediaWikiServices
::getInstance();
3379 $title = $this->getTitle();
3380 $ns = $title->getNamespace();
3381 $canonicalNamespace = MWNamespace
::exists( $ns )
3382 ? MWNamespace
::getCanonicalName( $ns )
3383 : $title->getNsText();
3385 $sk = $this->getSkin();
3386 // Get the relevant title so that AJAX features can use the correct page name
3387 // when making API requests from certain special pages (T36972).
3388 $relevantTitle = $sk->getRelevantTitle();
3389 $relevantUser = $sk->getRelevantUser();
3391 if ( $ns == NS_SPECIAL
) {
3392 list( $canonicalSpecialPageName, /*...*/ ) =
3393 $services->getSpecialPageFactory()->
3394 resolveAlias( $title->getDBkey() );
3395 } elseif ( $this->canUseWikiPage() ) {
3396 $wikiPage = $this->getWikiPage();
3397 $curRevisionId = $wikiPage->getLatest();
3398 $articleId = $wikiPage->getId();
3401 $lang = $title->getPageViewLanguage();
3403 // Pre-process information
3404 $separatorTransTable = $lang->separatorTransformTable();
3405 $separatorTransTable = $separatorTransTable ?
: [];
3406 $compactSeparatorTransTable = [
3407 implode( "\t", array_keys( $separatorTransTable ) ),
3408 implode( "\t", $separatorTransTable ),
3410 $digitTransTable = $lang->digitTransformTable();
3411 $digitTransTable = $digitTransTable ?
: [];
3412 $compactDigitTransTable = [
3413 implode( "\t", array_keys( $digitTransTable ) ),
3414 implode( "\t", $digitTransTable ),
3417 $user = $this->getUser();
3420 'wgCanonicalNamespace' => $canonicalNamespace,
3421 'wgCanonicalSpecialPageName' => $canonicalSpecialPageName,
3422 'wgNamespaceNumber' => $title->getNamespace(),
3423 'wgPageName' => $title->getPrefixedDBkey(),
3424 'wgTitle' => $title->getText(),
3425 'wgCurRevisionId' => $curRevisionId,
3426 'wgRevisionId' => (int)$this->getRevisionId(),
3427 'wgArticleId' => $articleId,
3428 'wgIsArticle' => $this->isArticle(),
3429 'wgIsRedirect' => $title->isRedirect(),
3430 'wgAction' => Action
::getActionName( $this->getContext() ),
3431 'wgUserName' => $user->isAnon() ?
null : $user->getName(),
3432 'wgUserGroups' => $user->getEffectiveGroups(),
3433 'wgCategories' => $this->getCategories(),
3434 'wgBreakFrames' => $this->getFrameOptions() == 'DENY',
3435 'wgPageContentLanguage' => $lang->getCode(),
3436 'wgPageContentModel' => $title->getContentModel(),
3437 'wgSeparatorTransformTable' => $compactSeparatorTransTable,
3438 'wgDigitTransformTable' => $compactDigitTransTable,
3439 'wgDefaultDateFormat' => $lang->getDefaultDateFormat(),
3440 'wgMonthNames' => $lang->getMonthNamesArray(),
3441 'wgMonthNamesShort' => $lang->getMonthAbbreviationsArray(),
3442 'wgRelevantPageName' => $relevantTitle->getPrefixedDBkey(),
3443 'wgRelevantArticleId' => $relevantTitle->getArticleID(),
3444 'wgRequestId' => WebRequest
::getRequestId(),
3445 'wgCSPNonce' => $this->getCSPNonce(),
3448 if ( $user->isLoggedIn() ) {
3449 $vars['wgUserId'] = $user->getId();
3450 $vars['wgUserEditCount'] = $user->getEditCount();
3451 $userReg = $user->getRegistration();
3452 $vars['wgUserRegistration'] = $userReg ?
wfTimestamp( TS_UNIX
, $userReg ) * 1000 : null;
3453 // Get the revision ID of the oldest new message on the user's talk
3454 // page. This can be used for constructing new message alerts on
3456 $vars['wgUserNewMsgRevisionId'] = $user->getNewMessageRevisionId();
3459 $contLang = $services->getContentLanguage();
3460 if ( $contLang->hasVariants() ) {
3461 $vars['wgUserVariant'] = $contLang->getPreferredVariant();
3463 // Same test as SkinTemplate
3464 $vars['wgIsProbablyEditable'] = $title->quickUserCan( 'edit', $user )
3465 && ( $title->exists() ||
$title->quickUserCan( 'create', $user ) );
3467 $vars['wgRelevantPageIsProbablyEditable'] = $relevantTitle
3468 && $relevantTitle->quickUserCan( 'edit', $user )
3469 && ( $relevantTitle->exists() ||
$relevantTitle->quickUserCan( 'create', $user ) );
3471 foreach ( $title->getRestrictionTypes() as $type ) {
3472 // Following keys are set in $vars:
3473 // wgRestrictionCreate, wgRestrictionEdit, wgRestrictionMove, wgRestrictionUpload
3474 $vars['wgRestriction' . ucfirst( $type )] = $title->getRestrictions( $type );
3477 if ( $title->isMainPage() ) {
3478 $vars['wgIsMainPage'] = true;
3481 if ( $this->mRedirectedFrom
) {
3482 $vars['wgRedirectedFrom'] = $this->mRedirectedFrom
->getPrefixedDBkey();
3485 if ( $relevantUser ) {
3486 $vars['wgRelevantUserName'] = $relevantUser->getName();
3489 // Allow extensions to add their custom variables to the mw.config map.
3490 // Use the 'ResourceLoaderGetConfigVars' hook if the variable is not
3491 // page-dependant but site-wide (without state).
3492 // Alternatively, you may want to use OutputPage->addJsConfigVars() instead.
3493 Hooks
::run( 'MakeGlobalVariablesScript', [ &$vars, $this ] );
3495 // Merge in variables from addJsConfigVars last
3496 return array_merge( $vars, $this->getJsConfigVars() );
3500 * To make it harder for someone to slip a user a fake
3501 * JavaScript or CSS preview, a random token
3502 * is associated with the login session. If it's not
3503 * passed back with the preview request, we won't render
3508 public function userCanPreview() {
3509 $request = $this->getRequest();
3511 $request->getVal( 'action' ) !== 'submit' ||
3512 !$request->wasPosted()
3517 $user = $this->getUser();
3519 if ( !$user->isLoggedIn() ) {
3520 // Anons have predictable edit tokens
3523 if ( !$user->matchEditToken( $request->getVal( 'wpEditToken' ) ) ) {
3527 $title = $this->getTitle();
3528 $errors = $title->getUserPermissionsErrors( 'edit', $user );
3529 if ( count( $errors ) !== 0 ) {
3537 * @return array Array in format "link name or number => 'link html'".
3539 public function getHeadLinksArray() {
3543 $config = $this->getConfig();
3545 $canonicalUrl = $this->mCanonicalUrl
;
3547 $tags['meta-generator'] = Html
::element( 'meta', [
3548 'name' => 'generator',
3549 'content' => "MediaWiki $wgVersion",
3552 if ( $config->get( 'ReferrerPolicy' ) !== false ) {
3553 // Per https://w3c.github.io/webappsec-referrer-policy/#unknown-policy-values
3554 // fallbacks should come before the primary value so we need to reverse the array.
3555 foreach ( array_reverse( (array)$config->get( 'ReferrerPolicy' ) ) as $i => $policy ) {
3556 $tags["meta-referrer-$i"] = Html
::element( 'meta', [
3557 'name' => 'referrer',
3558 'content' => $policy,
3563 $p = "{$this->mIndexPolicy},{$this->mFollowPolicy}";
3564 if ( $p !== 'index,follow' ) {
3565 // http://www.robotstxt.org/wc/meta-user.html
3566 // Only show if it's different from the default robots policy
3567 $tags['meta-robots'] = Html
::element( 'meta', [
3573 foreach ( $this->mMetatags
as $tag ) {
3574 if ( strncasecmp( $tag[0], 'http:', 5 ) === 0 ) {
3576 $tag[0] = substr( $tag[0], 5 );
3577 } elseif ( strncasecmp( $tag[0], 'og:', 3 ) === 0 ) {
3582 $tagName = "meta-{$tag[0]}";
3583 if ( isset( $tags[$tagName] ) ) {
3584 $tagName .= $tag[1];
3586 $tags[$tagName] = Html
::element( 'meta',
3589 'content' => $tag[1]
3594 foreach ( $this->mLinktags
as $tag ) {
3595 $tags[] = Html
::element( 'link', $tag );
3598 # Universal edit button
3599 if ( $config->get( 'UniversalEditButton' ) && $this->isArticleRelated() ) {
3600 $user = $this->getUser();
3601 if ( $this->getTitle()->quickUserCan( 'edit', $user )
3602 && ( $this->getTitle()->exists() ||
3603 $this->getTitle()->quickUserCan( 'create', $user ) )
3605 // Original UniversalEditButton
3606 $msg = $this->msg( 'edit' )->text();
3607 $tags['universal-edit-button'] = Html
::element( 'link', [
3608 'rel' => 'alternate',
3609 'type' => 'application/x-wiki',
3611 'href' => $this->getTitle()->getEditURL(),
3613 // Alternate edit link
3614 $tags['alternative-edit'] = Html
::element( 'link', [
3617 'href' => $this->getTitle()->getEditURL(),
3622 # Generally the order of the favicon and apple-touch-icon links
3623 # should not matter, but Konqueror (3.5.9 at least) incorrectly
3624 # uses whichever one appears later in the HTML source. Make sure
3625 # apple-touch-icon is specified first to avoid this.
3626 if ( $config->get( 'AppleTouchIcon' ) !== false ) {
3627 $tags['apple-touch-icon'] = Html
::element( 'link', [
3628 'rel' => 'apple-touch-icon',
3629 'href' => $config->get( 'AppleTouchIcon' )
3633 if ( $config->get( 'Favicon' ) !== false ) {
3634 $tags['favicon'] = Html
::element( 'link', [
3635 'rel' => 'shortcut icon',
3636 'href' => $config->get( 'Favicon' )
3640 # OpenSearch description link
3641 $tags['opensearch'] = Html
::element( 'link', [
3643 'type' => 'application/opensearchdescription+xml',
3644 'href' => wfScript( 'opensearch_desc' ),
3645 'title' => $this->msg( 'opensearch-desc' )->inContentLanguage()->text(),
3648 # Real Simple Discovery link, provides auto-discovery information
3649 # for the MediaWiki API (and potentially additional custom API
3650 # support such as WordPress or Twitter-compatible APIs for a
3651 # blogging extension, etc)
3652 $tags['rsd'] = Html
::element( 'link', [
3654 'type' => 'application/rsd+xml',
3655 // Output a protocol-relative URL here if $wgServer is protocol-relative.
3656 // Whether RSD accepts relative or protocol-relative URLs is completely
3657 // undocumented, though.
3658 'href' => wfExpandUrl( wfAppendQuery(
3660 [ 'action' => 'rsd' ] ),
3666 if ( !$config->get( 'DisableLangConversion' ) ) {
3667 $lang = $this->getTitle()->getPageLanguage();
3668 if ( $lang->hasVariants() ) {
3669 $variants = $lang->getVariants();
3670 foreach ( $variants as $variant ) {
3671 $tags["variant-$variant"] = Html
::element( 'link', [
3672 'rel' => 'alternate',
3673 'hreflang' => LanguageCode
::bcp47( $variant ),
3674 'href' => $this->getTitle()->getLocalURL(
3675 [ 'variant' => $variant ] )
3679 # x-default link per https://support.google.com/webmasters/answer/189077?hl=en
3680 $tags["variant-x-default"] = Html
::element( 'link', [
3681 'rel' => 'alternate',
3682 'hreflang' => 'x-default',
3683 'href' => $this->getTitle()->getLocalURL() ] );
3688 if ( $this->copyrightUrl
!== null ) {
3689 $copyright = $this->copyrightUrl
;
3692 if ( $config->get( 'RightsPage' ) ) {
3693 $copy = Title
::newFromText( $config->get( 'RightsPage' ) );
3696 $copyright = $copy->getLocalURL();
3700 if ( !$copyright && $config->get( 'RightsUrl' ) ) {
3701 $copyright = $config->get( 'RightsUrl' );
3706 $tags['copyright'] = Html
::element( 'link', [
3708 'href' => $copyright ]
3713 if ( $config->get( 'Feed' ) ) {
3716 foreach ( $this->getSyndicationLinks() as $format => $link ) {
3717 # Use the page name for the title. In principle, this could
3718 # lead to issues with having the same name for different feeds
3719 # corresponding to the same page, but we can't avoid that at
3722 $feedLinks[] = $this->feedLink(
3725 # Used messages: 'page-rss-feed' and 'page-atom-feed' (for an easier grep)
3727 "page-{$format}-feed", $this->getTitle()->getPrefixedText()
3732 # Recent changes feed should appear on every page (except recentchanges,
3733 # that would be redundant). Put it after the per-page feed to avoid
3734 # changing existing behavior. It's still available, probably via a
3735 # menu in your browser. Some sites might have a different feed they'd
3736 # like to promote instead of the RC feed (maybe like a "Recent New Articles"
3737 # or "Breaking news" one). For this, we see if $wgOverrideSiteFeed is defined.
3738 # If so, use it instead.
3739 $sitename = $config->get( 'Sitename' );
3740 if ( $config->get( 'OverrideSiteFeed' ) ) {
3741 foreach ( $config->get( 'OverrideSiteFeed' ) as $type => $feedUrl ) {
3742 // Note, this->feedLink escapes the url.
3743 $feedLinks[] = $this->feedLink(
3746 $this->msg( "site-{$type}-feed", $sitename )->text()
3749 } elseif ( !$this->getTitle()->isSpecial( 'Recentchanges' ) ) {
3750 $rctitle = SpecialPage
::getTitleFor( 'Recentchanges' );
3751 foreach ( $config->get( 'AdvertisedFeedTypes' ) as $format ) {
3752 $feedLinks[] = $this->feedLink(
3754 $rctitle->getLocalURL( [ 'feed' => $format ] ),
3755 # For grep: 'site-rss-feed', 'site-atom-feed'
3756 $this->msg( "site-{$format}-feed", $sitename )->text()
3761 # Allow extensions to change the list pf feeds. This hook is primarily for changing,
3762 # manipulating or removing existing feed tags. If you want to add new feeds, you should
3763 # use OutputPage::addFeedLink() instead.
3764 Hooks
::run( 'AfterBuildFeedLinks', [ &$feedLinks ] );
3766 $tags +
= $feedLinks;
3770 if ( $config->get( 'EnableCanonicalServerLink' ) ) {
3771 if ( $canonicalUrl !== false ) {
3772 $canonicalUrl = wfExpandUrl( $canonicalUrl, PROTO_CANONICAL
);
3774 if ( $this->isArticleRelated() ) {
3775 // This affects all requests where "setArticleRelated" is true. This is
3776 // typically all requests that show content (query title, curid, oldid, diff),
3777 // and all wikipage actions (edit, delete, purge, info, history etc.).
3778 // It does not apply to File pages and Special pages.
3779 // 'history' and 'info' actions address page metadata rather than the page
3780 // content itself, so they may not be canonicalized to the view page url.
3781 // TODO: this ought to be better encapsulated in the Action class.
3782 $action = Action
::getActionName( $this->getContext() );
3783 if ( in_array( $action, [ 'history', 'info' ] ) ) {
3784 $query = "action={$action}";
3788 $canonicalUrl = $this->getTitle()->getCanonicalURL( $query );
3790 $reqUrl = $this->getRequest()->getRequestURL();
3791 $canonicalUrl = wfExpandUrl( $reqUrl, PROTO_CANONICAL
);
3795 if ( $canonicalUrl !== false ) {
3796 $tags[] = Html
::element( 'link', [
3797 'rel' => 'canonical',
3798 'href' => $canonicalUrl
3802 // Allow extensions to add, remove and/or otherwise manipulate these links
3803 // If you want only to *add* <head> links, please use the addHeadItem()
3804 // (or addHeadItems() for multiple items) method instead.
3805 // This hook is provided as a last resort for extensions to modify these
3806 // links before the output is sent to client.
3807 Hooks
::run( 'OutputPageAfterGetHeadLinksArray', [ &$tags, $this ] );
3813 * Generate a "<link rel/>" for a feed.
3815 * @param string $type Feed type
3816 * @param string $url URL to the feed
3817 * @param string $text Value of the "title" attribute
3818 * @return string HTML fragment
3820 private function feedLink( $type, $url, $text ) {
3821 return Html
::element( 'link', [
3822 'rel' => 'alternate',
3823 'type' => "application/$type+xml",
3830 * Add a local or specified stylesheet, with the given media options.
3831 * Internal use only. Use OutputPage::addModuleStyles() if possible.
3833 * @param string $style URL to the file
3834 * @param string $media To specify a media type, 'screen', 'printable', 'handheld' or any.
3835 * @param string $condition For IE conditional comments, specifying an IE version
3836 * @param string $dir Set to 'rtl' or 'ltr' for direction-specific sheets
3838 public function addStyle( $style, $media = '', $condition = '', $dir = '' ) {
3841 $options['media'] = $media;
3844 $options['condition'] = $condition;
3847 $options['dir'] = $dir;
3849 $this->styles
[$style] = $options;
3853 * Adds inline CSS styles
3854 * Internal use only. Use OutputPage::addModuleStyles() if possible.
3856 * @param mixed $style_css Inline CSS
3857 * @param string $flip Set to 'flip' to flip the CSS if needed
3859 public function addInlineStyle( $style_css, $flip = 'noflip' ) {
3860 if ( $flip === 'flip' && $this->getLanguage()->isRTL() ) {
3861 # If wanted, and the interface is right-to-left, flip the CSS
3862 $style_css = CSSJanus
::transform( $style_css, true, false );
3864 $this->mInlineStyles
.= Html
::inlineStyle( $style_css );
3868 * Build exempt modules and legacy non-ResourceLoader styles.
3870 * @return string|WrappedStringList HTML
3872 protected function buildExemptModules() {
3874 // Things that go after the ResourceLoaderDynamicStyles marker
3877 // We want site, private and user styles to override dynamically added styles from
3878 // general modules, but we want dynamically added styles to override statically added
3879 // style modules. So the order has to be:
3880 // - page style modules (formatted by ResourceLoaderClientHtml::getHeadHtml())
3881 // - dynamically loaded styles (added by mw.loader before ResourceLoaderDynamicStyles)
3882 // - ResourceLoaderDynamicStyles marker
3883 // - site/private/user styles
3885 // Add legacy styles added through addStyle()/addInlineStyle() here
3886 $chunks[] = implode( '', $this->buildCssLinksArray() ) . $this->mInlineStyles
;
3888 $chunks[] = Html
::element(
3890 [ 'name' => 'ResourceLoaderDynamicStyles', 'content' => '' ]
3893 $separateReq = [ 'site.styles', 'user.styles' ];
3894 foreach ( $this->rlExemptStyleModules
as $group => $moduleNames ) {
3895 // Combinable modules
3896 $chunks[] = $this->makeResourceLoaderLink(
3897 array_diff( $moduleNames, $separateReq ),
3898 ResourceLoaderModule
::TYPE_STYLES
3901 foreach ( array_intersect( $moduleNames, $separateReq ) as $name ) {
3902 // These require their own dedicated request in order to support "@import"
3903 // syntax, which is incompatible with concatenation. (T147667, T37562)
3904 $chunks[] = $this->makeResourceLoaderLink( $name,
3905 ResourceLoaderModule
::TYPE_STYLES
3910 return self
::combineWrappedStrings( array_merge( $chunks, $append ) );
3916 public function buildCssLinksArray() {
3919 foreach ( $this->styles
as $file => $options ) {
3920 $link = $this->styleLink( $file, $options );
3922 $links[$file] = $link;
3929 * Generate \<link\> tags for stylesheets
3931 * @param string $style URL to the file
3932 * @param array $options Option, can contain 'condition', 'dir', 'media' keys
3933 * @return string HTML fragment
3935 protected function styleLink( $style, array $options ) {
3936 if ( isset( $options['dir'] ) ) {
3937 if ( $this->getLanguage()->getDir() != $options['dir'] ) {
3942 if ( isset( $options['media'] ) ) {
3943 $media = self
::transformCssMedia( $options['media'] );
3944 if ( is_null( $media ) ) {
3951 if ( substr( $style, 0, 1 ) == '/' ||
3952 substr( $style, 0, 5 ) == 'http:' ||
3953 substr( $style, 0, 6 ) == 'https:' ) {
3956 $config = $this->getConfig();
3957 // Append file hash as query parameter
3958 $url = self
::transformResourcePath(
3960 $config->get( 'StylePath' ) . '/' . $style
3964 $link = Html
::linkedStyle( $url, $media );
3966 if ( isset( $options['condition'] ) ) {
3967 $condition = htmlspecialchars( $options['condition'] );
3968 $link = "<!--[if $condition]>$link<![endif]-->";
3974 * Transform path to web-accessible static resource.
3976 * This is used to add a validation hash as query string.
3977 * This aids various behaviors:
3979 * - Put long Cache-Control max-age headers on responses for improved
3980 * cache performance.
3981 * - Get the correct version of a file as expected by the current page.
3982 * - Instantly get the updated version of a file after deployment.
3984 * Avoid using this for urls included in HTML as otherwise clients may get different
3985 * versions of a resource when navigating the site depending on when the page was cached.
3986 * If changes to the url propagate, this is not a problem (e.g. if the url is in
3987 * an external stylesheet).
3990 * @param Config $config
3991 * @param string $path Path-absolute URL to file (from document root, must start with "/")
3992 * @return string URL
3994 public static function transformResourcePath( Config
$config, $path ) {
3998 $remotePathPrefix = $config->get( 'ResourceBasePath' );
3999 if ( $remotePathPrefix === '' ) {
4000 // The configured base path is required to be empty string for
4001 // wikis in the domain root
4004 $remotePath = $remotePathPrefix;
4006 if ( strpos( $path, $remotePath ) !== 0 ||
substr( $path, 0, 2 ) === '//' ) {
4007 // - Path is outside wgResourceBasePath, ignore.
4008 // - Path is protocol-relative. Fixes T155310. Not supported by RelPath lib.
4011 // For files in resources, extensions/ or skins/, ResourceBasePath is preferred here.
4012 // For other misc files in $IP, we'll fallback to that as well. There is, however, a fourth
4013 // supported dir/path pair in the configuration (wgUploadDirectory, wgUploadPath)
4014 // which is not expected to be in wgResourceBasePath on CDNs. (T155146)
4015 $uploadPath = $config->get( 'UploadPath' );
4016 if ( strpos( $path, $uploadPath ) === 0 ) {
4017 $localDir = $config->get( 'UploadDirectory' );
4018 $remotePathPrefix = $remotePath = $uploadPath;
4021 $path = RelPath
::getRelativePath( $path, $remotePath );
4022 return self
::transformFilePath( $remotePathPrefix, $localDir, $path );
4026 * Utility method for transformResourceFilePath().
4028 * Caller is responsible for ensuring the file exists. Emits a PHP warning otherwise.
4031 * @param string $remotePathPrefix URL path prefix that points to $localPath
4032 * @param string $localPath File directory exposed at $remotePath
4033 * @param string $file Path to target file relative to $localPath
4034 * @return string URL
4036 public static function transformFilePath( $remotePathPrefix, $localPath, $file ) {
4037 $hash = md5_file( "$localPath/$file" );
4038 if ( $hash === false ) {
4039 wfLogWarning( __METHOD__
. ": Failed to hash $localPath/$file" );
4042 return "$remotePathPrefix/$file?" . substr( $hash, 0, 5 );
4046 * Transform "media" attribute based on request parameters
4048 * @param string $media Current value of the "media" attribute
4049 * @return string Modified value of the "media" attribute, or null to skip
4052 public static function transformCssMedia( $media ) {
4055 // https://www.w3.org/TR/css3-mediaqueries/#syntax
4056 $screenMediaQueryRegex = '/^(?:only\s+)?screen\b/i';
4058 // Switch in on-screen display for media testing
4060 'printable' => 'print',
4061 'handheld' => 'handheld',
4063 foreach ( $switches as $switch => $targetMedia ) {
4064 if ( $wgRequest->getBool( $switch ) ) {
4065 if ( $media == $targetMedia ) {
4067 } elseif ( preg_match( $screenMediaQueryRegex, $media ) === 1 ) {
4068 /* This regex will not attempt to understand a comma-separated media_query_list
4070 * Example supported values for $media:
4071 * 'screen', 'only screen', 'screen and (min-width: 982px)' ),
4072 * Example NOT supported value for $media:
4073 * '3d-glasses, screen, print and resolution > 90dpi'
4075 * If it's a print request, we never want any kind of screen stylesheets
4076 * If it's a handheld request (currently the only other choice with a switch),
4077 * we don't want simple 'screen' but we might want screen queries that
4078 * have a max-width or something, so we'll pass all others on and let the
4079 * client do the query.
4081 if ( $targetMedia == 'print' ||
$media == 'screen' ) {
4092 * Add a wikitext-formatted message to the output.
4093 * This is equivalent to:
4095 * $wgOut->addWikiText( wfMessage( ... )->plain() )
4097 public function addWikiMsg( /*...*/ ) {
4098 $args = func_get_args();
4099 $name = array_shift( $args );
4100 $this->addWikiMsgArray( $name, $args );
4104 * Add a wikitext-formatted message to the output.
4105 * Like addWikiMsg() except the parameters are taken as an array
4106 * instead of a variable argument list.
4108 * @param string $name
4109 * @param array $args
4111 public function addWikiMsgArray( $name, $args ) {
4112 $this->addHTML( $this->msg( $name, $args )->parseAsBlock() );
4116 * This function takes a number of message/argument specifications, wraps them in
4117 * some overall structure, and then parses the result and adds it to the output.
4119 * In the $wrap, $1 is replaced with the first message, $2 with the second,
4120 * and so on. The subsequent arguments may be either
4121 * 1) strings, in which case they are message names, or
4122 * 2) arrays, in which case, within each array, the first element is the message
4123 * name, and subsequent elements are the parameters to that message.
4125 * Don't use this for messages that are not in the user's interface language.
4129 * $wgOut->wrapWikiMsg( "<div class='error'>\n$1\n</div>", 'some-error' );
4133 * $wgOut->addWikiTextAsInterface( "<div class='error'>\n"
4134 * . wfMessage( 'some-error' )->plain() . "\n</div>" );
4136 * The newline after the opening div is needed in some wikitext. See T21226.
4138 * @param string $wrap
4140 public function wrapWikiMsg( $wrap /*, ...*/ ) {
4141 $msgSpecs = func_get_args();
4142 array_shift( $msgSpecs );
4143 $msgSpecs = array_values( $msgSpecs );
4145 foreach ( $msgSpecs as $n => $spec ) {
4146 if ( is_array( $spec ) ) {
4148 $name = array_shift( $args );
4149 if ( isset( $args['options'] ) ) {
4150 unset( $args['options'] );
4152 'Adding "options" to ' . __METHOD__
. ' is no longer supported',
4160 $s = str_replace( '$' . ( $n +
1 ), $this->msg( $name, $args )->plain(), $s );
4162 $this->addWikiTextAsInterface( $s );
4166 * Whether the output has a table of contents
4170 public function isTOCEnabled() {
4171 return $this->mEnableTOC
;
4175 * Enables/disables section edit links, doesn't override __NOEDITSECTION__
4178 * @deprecated since 1.31, use $poOptions to addParserOutput() instead.
4180 public function enableSectionEditLinks( $flag = true ) {
4181 wfDeprecated( __METHOD__
, '1.31' );
4187 * @deprecated since 1.31, use $poOptions to addParserOutput() instead.
4189 public function sectionEditLinksEnabled() {
4190 wfDeprecated( __METHOD__
, '1.31' );
4195 * Helper function to setup the PHP implementation of OOUI to use in this request.
4198 * @param string $skinName The Skin name to determine the correct OOUI theme
4199 * @param string $dir Language direction
4201 public static function setupOOUI( $skinName = 'default', $dir = 'ltr' ) {
4202 $themes = ResourceLoaderOOUIModule
::getSkinThemeMap();
4203 $theme = $themes[$skinName] ??
$themes['default'];
4204 // For example, 'OOUI\WikimediaUITheme'.
4205 $themeClass = "OOUI\\{$theme}Theme";
4206 OOUI\Theme
::setSingleton( new $themeClass() );
4207 OOUI\Element
::setDefaultDir( $dir );
4211 * Add ResourceLoader module styles for OOUI and set up the PHP implementation of it for use with
4212 * MediaWiki and this OutputPage instance.
4216 public function enableOOUI() {
4218 strtolower( $this->getSkin()->getSkinName() ),
4219 $this->getLanguage()->getDir()
4221 $this->addModuleStyles( [
4222 'oojs-ui-core.styles',
4223 'oojs-ui.styles.indicators',
4224 'oojs-ui.styles.textures',
4225 'mediawiki.widgets.styles',
4226 'oojs-ui.styles.icons-content',
4227 'oojs-ui.styles.icons-alerts',
4228 'oojs-ui.styles.icons-interactions',
4233 * Get (and set if not yet set) the CSP nonce.
4235 * This value needs to be included in any <script> tags on the
4238 * @return string|bool Nonce or false to mean don't output nonce
4241 public function getCSPNonce() {
4242 if ( !ContentSecurityPolicy
::isNonceRequired( $this->getConfig() ) ) {
4245 if ( $this->CSPNonce
=== null ) {
4246 // XXX It might be expensive to generate randomness
4247 // on every request, on Windows.
4248 $rand = random_bytes( 15 );
4249 $this->CSPNonce
= base64_encode( $rand );
4251 return $this->CSPNonce
;